Skip to content

Latest commit

 

History

History
252 lines (177 loc) · 7.29 KB

README.md

File metadata and controls

252 lines (177 loc) · 7.29 KB

Contributors Forks Stargazers Issues MIT License


Logo

Regybox API

Consists of an API to make the job of scheduling classes in the Regibox app easier.
Explore the Website

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Logo

This project was developed to make scheduling classes in the Regibox app easier. It has all the necessary tools to send requests to the Regibox API and get the necessary information to schedule classes. It also has a web interface to make the process easier.

(back to top)

Built With

  • Django
  • React
  • Bootstrap
  • Requests

(back to top)

Getting Started

This project uses requests to send and receive data from the Regibox. It also uses a web interface to make the process easier.

If you only want the api to communicate with the Regibox, you can use the Regybox_API.py file under base folder. If you want to use the web interface, follow the next steps

Prerequisites

  1. To install the project, clone the repository:
git clone https://github.com/andrefdre/RegyBox_API.git
  1. Install the requirements:
cd backend
pip install -r requirements.txt
  1. Create a .env file in the backend folder with the following variables:
SECRET_KEY=your_secret_key
  1. Create a .env file in the frontend folder with the following variables:
REACT_APP_BACK_END_IP = your_ip_address

Installation

  1. Make Migrations for the app
python3 manage.py makemigrations
  1. Migration
python3 manage.py migrate
  1. Install the frontend dependencies
cd ..
cd frontend
npm install

(back to top)

Usage

  1. Run the server and the frontend
npm start_both_apps

If you want to run the server and the frontend separately, you can use the following commands:

npm start-react

npm start-django

To access the web interface, go to http://localhost:3000

If you want to deploy the project with docker, you can use the following command:
docker-compose up --build

To run the docker container in the background, you can use the following command:

docker-compose up -d

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPL License. See LICENSE.txt for more information.

(back to top)

Contact

André Cardoso - [email protected]

Project Link: RegyBox API

(back to top)