This repository contains the backend code necessary to run the platform for managing web site logic and operations for our Appalachia project.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of Docker and Docker Compose.
- You have a basic understanding of Docker containerization and Docker Compose.
To set up the Farmeris platform, follow these steps:
- Clone the repository to your local machine:
git clone git@gitlab.com:farmeris/farmeris.git
- Navigate to the cloned directory:
cd farmeris
- To build and run the Docker containers in the background using the
Makefile, execute:
make farmeris_full
This command builds the Docker image and runs the containers as specified in your docker-compose.prod.yml file.
If you wish to run the project without Docker:
- Create a virtual environment in the project directory:
python -m venv myvenv
- Activate the virtual environment:
-
On Windows:
venv\Scripts\activate -
On Unix or MacOS:
source venv/bin/activate
- Install the required dependencies:
pip install -r requirements.txt
- Run the Django development server:
python manage.py runserver
The Django application will start on the default port 8000.
After setting up the project with Docker, you can manage the Docker containers using Docker Compose commands. Here are some common commands you might find useful:
- To start the services:
docker-compose -f docker-compose.prod.yml up
- To rebuild the services:
docker-compose -f docker-compose.prod.yml up --build
- To stop the services:
docker-compose -f docker-compose.prod.yml down
For more detailed information on Docker Compose commands, refer to the Docker Compose documentation.
To contribute to Farmeris, follow these steps:
- Fork this repository.
- Clone your fork to your local machine:
git clone https://gitlab.com/farmeris/farmeris.git
- Navigate to the directory:
cd farmeris
- Create a new branch for your feature or fix:
git checkout -b my-feature-branch
- Make your changes and commit them:
git commit -m "Detailed description of your changes"
- Push the changes to your fork:
git push origin my-feature-branch
- Visit the original repository on GitLab and you'll see a prompt to create a pull request from your new branch.
Alternatively, see the GitLab documentation on creating a merge request.
If you have any questions or would like to contact the maintainers, please email us at farmeris@farmeris.sk
This project is open-sourced under the GNU Affero General Public License (AGPLv3). For more information, see the AGPLv3 License.