Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leomssilva/feedget
:technologist: :iphone: :speech_balloon: This repository contains a fullstack web/mobile application. It is used to send feedback with images and comments.
https://github.com/leomssilva/feedget
Last synced: about 6 hours ago
JSON representation
:technologist: :iphone: :speech_balloon: This repository contains a fullstack web/mobile application. It is used to send feedback with images and comments.
- Host: GitHub
- URL: https://github.com/leomssilva/feedget
- Owner: LeoMSSilva
- License: mit
- Created: 2022-05-02T23:46:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T00:42:24.000Z (2 months ago)
- Last Synced: 2024-08-29T01:44:46.574Z (2 months ago)
- Language: TypeScript
- Homepage: https://feedget-leomssilva.vercel.app
- Size: 2.15 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
Feedget
[](https://github.com/LeoMSSilva)
[](https://github.com/LeoMSSilva)
[](#)
[](https://github.com/LeoMSSilva/Feedget/stargazers)
[](https://github.com/LeoMSSilva/Feedget/network/members)
[](https://github.com/LeoMSSilva/Feedget/graphs/contributors)
---
# :pushpin: Table of Contents
- :house: [About](#house-about)
- :dart: [Installation](#dart-installation)
- :gear: [Install dependencies](#hammer_and_wrench-install-dependencies)
- :rocket: [Getting started](#rocket-getting-started)
- :computer: [Techs](#computer-techs)
- :bust_in_silhouette: [Author](#bust_in_silhouette-author)
- :handshake: [Contributing](#handshake-contributing)
- :scroll: [License](#scroll-license)
---
# :house: 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.
---
# :dart: Installation
**First you need to install:**
- [Node.js](https://pt-br.nodejs.org/) (required)
- [Yarn](https://yarnpkg.com/) (required)
**Then in order, clone the project.**
By HTTPS, running this command:
```bash
git clone https://github.com/LeoMSSilva/Feedget.git
```
Or by ssh, running this command:
```bash
git clone [email protected]:LeoMSSilva/Feedget.git
```
SSH is a secure protocol, but you need to register a key ssh in your github before.
## :hammer_and_wrench: Install dependencies
```bash
yarn
```
or
```bash
yarn install
```
## :rocket: Getting Started
To run the *front-end* use:
```bash
cd web
```
Or to run the *back-end* use:
```bash
cd server
```
After being in the folder, run the following command to start the project:
```bash
yarn dev
```
---
# :computer: 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
---
# :bust_in_silhouette: Author
**LeoMSSilva**
- Github: [@LeoMSSilva](https://github.com/LeoMSSilva)
- LinkedIn: [@LeoMSSilva](https://linkedin.com/in/LeoMSSilva)
---
# :handshake: Contributing
Contributions, issues and feature requests are welcome! Feel free to **file a new issue** on the [Feedget](https://github.com/LeoMSSilva/Feedget/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**!
---
# :scroll: License
Copyright :copyright: 2022 [LeoMSSilva](https://github.com/LeoMSSilva).
This project is [MIT](https://github.com/LeoMSSilva/Feedget/blob/main/LICENSE) licensed.
---