Project | Technologies | Documentation | How to contribute
This project is a GymPass Checkin-style API that allows users to register, authenticate, perform check-ins at gyms, validate check-ins, view their check-in history, search for nearby gyms, and register new gyms. The API meets non-functional requirements such as password encryption, data persistence in a PostgreSQL database, and user identification using JWT (JSON Web Token).
The project is based on the following technologies:
- ✨ TypeScript — Static typing for JavaScript.
- 📦 ESLint — A fully pluggable tool for identifying and reporting on patterns in JavaScript.
- 📦 Prettier — A tool to keep code style consistent.
- 📦 Editor Config — A tool to maintain consistent coding styles between different editors and IDEs.
Coming soon...
- Fork this repository;
- Create a new branch with your feature:
git checkout -b feature/my-feature; - Commit your changes:
git commit -m 'feat: awesome feature'; - Push to your branch:
git push origin feature/my-feature.
Once your pull request has been merged, you can delete your branch.
Made with 💙 & ☕ by João Bispo😎