User registration application capable of creating, reading, updating and deleting database users (CRUD). The project is divided into Front-end and Back-end, both environments (and the database) run inside a container created by Docker Compose 🐳.
🧰 Powered by
- Next.js
- Sass/Scss
- TypeScript
- Node.js
- Express
- Prism
- PostgreSQL
- Docker
🔧 Installation
⚠️ You must have Docker and Docker Compose installed on your machine to run this project in containers.
- Clone this repository:
git clone [email protected]:adilsongb/registrado-app.git
- Access the project folder:
app-registered cd
- Upload application containers using Docker Compose command:
📌 The process of installing the dependencies is done during the construction of the container for each environment.
docker-compose up
⚠️ The development environment is created using thedocker-compose.ymlfile! With it, the Back and Front containers are updated with each change made to the project files.
- All very well! You can access the application at the following addresses:
- Frontend:
http://localhost:3000/ - Backend:
http://localhost:3001/
- Frontend:
💻 Deploy
- The deployment is performed on the Heroku platform. Application links:
- The deployment of both environments (Front and Back-end) is performed automatically through GitHub Actions. Any change made to the
mainbranch of the project's remote repository starts the deployment process. - The deploy action file can be found at:
.github/workflows/main.yml.
💡 Hint
- In the project there is a file
app.code-workspace, with it a workspace is created in VSCode separating the Front-end and the Back-end of the application.
- The application's back-end was developed with
Node.js,TypeScript,ExpressandPrisma. The application can be accessed locally (if the container is running) athttp://localhost:3001/.
📁 Organization
└── 📂 registered-app
├── 📂 backend
| ├── 📂 prism
| | ├── 📁 migrations // Prisma schema migration history
| | ├── 📄 seed.ts // File with initial DB data
| | └── 📄 schema.prisma // File that references and configures DB tables
| └── 📂 src
│ ├── 📂 database
│ | └── 📄 connection.ts // Connect to the database through Prisma Client
| ├── 📁 models // Folder with files that communicate directly with DB
| ├── 📁 services // Folder with files that connect the client and DB
| ├── 📁 controllers // Folder with files that communicate directly with the client
| ├── 📁 interfaces // Folder with object typing interfaces
| ├── 📁 validations // Folder with the validations performed by the Joi library
| ├── 📁 middleware
| | └── 📄 error.ts // Middleware for API error handling
| ├── 📁 routes // Folder with API routes (Endpoints)
| └── 📄 server.ts // API configuration and initialization file
└── 📁 frontend
🎯 Endpoints
GET
-
-
Returns an array containing 10 users. Depending on the number passed in the
:pageparameter only a specific fraction of users is returned, for example: The/users/page/2endpoint returns users of order 11-20. (Endpoint created especially to give the pagination effect on the Front-end)🪃 Return example
[ { "id": 1, "name": "Adilson Gabriel", "email": "[email protected]", "password": "F4MAJVQ3hkFElTb", "createdAt": "2022-05-26T21:42:34.364Z" }, { "id": 2, "name": "Carlos Nogueira", "email": "[email protected]", "password": "GsI2Y00ca05Lftu", "createdAt": "2022-05-26T21:42:34.364Z" },
-
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent