README.md

GymPoint Fullstack app

Project   |    Built with   |    How to run   |    License   |    Get in touch

💻 Project

Gym management app, that allows the admin to manage students, plans, memberships and answer to student requests on the web app and students can check-in and create orders on the mobile app.

🚀 Built with

This project was developed with the following technologies:

• Node.js
• ReactJS
• React Native
• Redux
• Redux-Saga
• Redux-persist
• @rocketseat/unform
• Styled-components
• React-toastify
• React Navigation
• React-icons
• Axios
• Reactotron
• Immer
• Polished
• Yup
• Bee-queue
• Date-fns
• Prop-types
• ESLint
• Prettier
• VS Code

ℹ️ How to run

Requirements

To run the application you will need:

• Git
• Node
• Yarn

I strongly recommend using Docker to run the databases.
If you decide to use docker, follow this steps to install and run the docker images.

# install Redis image
$ docker run --name imageName -p 6379:6379 -d -t redis:alpine

# install Postgres image (if you don't specify an username it will be postgres by default)
$ docker run --name imagename -e POSTGRES_PASSWORD=yourPassword -p 5432:5432 -d postgres

# start Redis
$ docker start imageName

# start Postgres
$ docker start imageName

Backend

Now clone the repository and install the dependencies.

# to clone the repository
$ git clone https://github.com/StefanoSaffran/gympoint.git

# go into the backend folder
$ cd gympoint/backend

#install the backend dependencies
$ yarn

In order to connect to the database, you will need to enter the access informations into a .env file, based on a .env.example file that is provided in the backend folder, change the variables according to your environment.

# run migrations
$ yarn sequelize db:migrate

# run seeds
$ yarn sequelize db:seed:all

# run api
$ yarn dev & yarn queue

Frontend

# in another tab of the terminal install the frontend dependencies and run it 
$ cd frontend
$ yarn
$ yarn start

Use this credentials to access the web application

email: admin@gympoint.com

senha: 123456

Mobile

for mobile you need the Android emulator with the SDK installed or IOS emulator and the react-native cli.

The project was developed and tested on Android emulator

# install dependencies and run the mobile
$ cd mobile
$ yarn

# first open the emulator and start the react native server
$ yarn start

# in another tab install and run the app
$ yarn android

this part can be tricky, if you face some error, try running yarn start --reset-cache and yarn android again.

📄 License

This project is under the MIT license. See the LICENSE for more information

📬 Get in touch!

       

---

Made with ☕ and ❤️ by Stefano Saffran.