gympoint-web
gympoint-web copied to clipboard
Admin platform of a gym management application - Built with React.js, Styled Components and Redux
Gympoint Web
Manage a gym with a agile and intuitive application that will help your business to grow :rocket:
:pushpin: Table of Contents
- Features
- Installation
- Getting Started
- FAQ
- Found a bug? Missing a specific feature?
- Contributing
- License
:rocket: Features
- Manage students
- Manage plans
- Manage enrollments
- Help students with their doubts by receiving and answering their questions.
It's important to mention that this is one of the applications from the Gympoint System
In order to explore the others, feel free to click in the links above:
:construction_worker: Installation
You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:
git clone https://github.com/LauraBeatris/gympoint-web.git
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:
git clone [email protected]:LauraBeatris/gympoint-web.git
Install dependencies
yarn install
Create your enviroment variables based on the examples of .env.example
cp .env.example .env
After copying the examples, make sure to fill the variables with new values.
Setup the API
The interface needs to interact with the server to get all the data related to students, enrollments, plans and also execute mutations.
Make sure to go to the Gympoint Rest API repository and follow the instructions in order to get it running in your machine.
:runner: Getting Started
Run the following command in order to start the application in a development environment:
yarn start
:postbox: Faq
Question: What are the tecnologies used in this project?
Answer: The tecnologies used in this project are React + Styled Components to handle scoped CSS.
:bug: Issues
Feel free to file a new issue with a respective title and description on the the Gympoint Web repository. If you already found a solution to your problem, i would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.
:tada: Contributing
Check out the contributing page to see the best places to file issues, start discussions and begin contributing.
:closed_book: License
Released in 2019. This project is under the MIT license.
Made with love by Laura Beatris 💜🚀