Feedget

---

📌 Table of Contents

• 🏠 About
• 🎯 Installation
  • ⚙️ Install dependencies
  • 🚀 Getting started
• 💻 Techs
• 👤 Author
• 🤝 Contributing
• 📜 License

---

🏠 About

This repository contains a fullstack web/mobile application. It is used to send feedback with images and comments.

To the front-end:

• Vite to manage the entire application.

• Typescript as a programming language used through the reactJs framework and transpiled to javascript.

• React dom to route application navigation.

• TailwindCss together with postcss and autoprefixer to style the web application.

• TailwindCss scrollbar to handle web page scrollbar.

• HeadlessUI to implement accessibility in the application.

• Phosphor react to use icons.

• Html2canvas to perform page capture.

To the back-end:

• Typescript as a programming language used through the nodeJs framework and transpiled to javascript.

• ExpressJs to create a server.

• Cors to allow access to api.

• Prisma to manage the entire application connection with the database.

• SQLite as a development database.

• Nodemailer to send emails.

• Ts-node to allow typescript code transpilation and jest execution, along with @swc/cli, @swc/core and @swc/jest to actually transpile code to typescript in javascript.

• Jest to perform automated unit tests.

• SOLID design pattern to make the application more scalable.

---

🎯 Installation

First you need to install:

• Node.js (required)

• Yarn (required)

  Then in order, clone the project.

By HTTPS, running this command:

  git clone https://github.com/LeoMSSilva/Feedget.git

Or by ssh, running this command:

  git clone git@github.com:LeoMSSilva/Feedget.git

SSH is a secure protocol, but you need to register a key ssh in your github before.

🛠️ Install dependencies

  yarn

or

  yarn install

🚀 Getting Started

To run the front-end use:

  cd web

Or to run the back-end use:

  cd server

After being in the folder, run the following command to start the project:

  yarn dev

---

💻 Techs

• @swc/cli
• @swc/core
• @swc/jest
• Autoprefixer
• Cors
• ExpressJs
• HeadlessUI
• Html2canvas
• Javascript
• Jest
• NodeJs
• Nodemailer
• Phosphor React
• Postcss
• Prisma
• React Dom
• ReactJs
• SOLID
• SQLite
• TailwindCss
• TailwindCss Scrollbar
• Typescript
• Ts-node
• Vite

---

👤 Author

LeoMSSilva

• Github: @LeoMSSilva
• LinkedIn: @LeoMSSilva

---

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to file a new issue on the Feedget repository. If you already found a solution to your problem, I would love to review your pull request!

---

📜 License

Copyright ©️ 2022 LeoMSSilva.
This project is MIT licensed.

---