Welcome to the Maticas API repository! This is the database and API branch of the Maticas project. We are using the Django framework for the database and REST technology for the API structure.
To get started with the Maticas API, you'll need to follow these steps:
- Clone this repository to your local machine using git clone https://github.com/maticas-org/maticas-api.git
- Install Docker and docker-compose on your machine by following the instructions on the official Docker website.
- Open a terminal and navigate to the root directory of the project.
- Start the app with
docker-compose up. This command will create and start the containers for the API and database services defined in thedocker-compose.ymlfile. - Open a web browser and go to http://localhost:8000/. You should see the API homepage.
- Start making API requests!
Note: If you make changes to the code and want to see them reflected in the running app, simply stop the running containers with docker-compose down and start them again with docker-compose up.
The Maticas API is released under the MIT License. Please see the LICENSE file for more details.