gostack-gympoint
gostack-gympoint copied to clipboard
💪 a complete gym management system
Rocketseat bootcamp project. The project is a back-end, web and mobile system for control and interaction between gyms and their students. It has features like login, enrollment, training, plans, payments, aid applications, etc.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
- NodeJS - Environment runtime
- Yarn - Packager manager
- Docker - Make it easier to create, deploy, and run applications by using containers
- Docker Compose - Relies on Docker Engine for any meaningful work, so make sure you have Docker Engine installed either locally or remote, depending on your setup.
What things you need to install the software and how to install them
$> git clone https://github.com/jopcmelo/gostack-gympoint.git
Installing
A step by step series of examples that tell you how to get a development env running
Databases
First thing you must do is setup all your database settings. To do it, I have created a docker-compose.yml file do help you
$> docker-compose up -d
Back-end
First install back-end dependencies
$> cd ./backend/ && yarn
Start back-end service
$> yarn dev
Front-end
First install front-end dependencies
$> cd ./frontend/ && yarn
Then run app
$> yarn start
Mobile
Mobile version is comming soon...
Built With
- Express - A restful API framework
- ReactJS - A front-end library to build user interfaces
- React Native - A mobile library to build native apps to Android and iOS
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Authors
- João Melo - Full-stack developer - GitHub profile
- Raphael Oliveira - Full-stack developer - GitHub profile
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
- ExpressJS ecossystem
- MVC design pattern
- Sequelize ORM
- Background mail sendling with Redis
- Sentry
- Multer
- JWT
- Docker
- React ecossystem
- React Hooks
- ReactJS
- React Native
- Reactotron
- React Navigation / React Router DOM
- React Toastify
- Redux
- Redux Saga
- Redux Persist
- Flux Archtecture
- ESLint
- Prettier
- Styled Components
- Unform
- Axios
- History
- Etc