Me Adota - Documentations

This is the general documentation for Me Adota website.
It runs on MKDocs.
Versão em PT-BR aqui.

---

Me-Adota

Recommended requirements for application

You must have Python 3.8, Pip 20.2 and Postgres 20 installed on your machine.

Installing and Running

1. Clone the repository

$ git clone https://github.com/Me-Adota/website

2. Access the repository directory

$ cd website

3. You must activate the venv bin, it will be activated using

$ virtualenv venv

$ source venv/bin/activate

4. You must copy the dev.env file to a new file called .env

$ cp dev.env venv

5. The requirements.txt file should list all Python libraries that your machine depend on, and they will be installed using

$ pip install -r requirements.txt

6. Make all the migrations

$ python manage.py makemigrations

$ python manage.py migrate

7. Run the server:

$ python manage.py runserver

It should be running on: http://127.0.0.1:8000

License

This project is licensed under the MIT License - see the LICENSE.md file for details.