diff --git a/docs/contributing.md b/docs/contributing.md index 4905f8d..8d10ce7 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -71,7 +71,7 @@ Ready to contribute? Here’s how to set up `growth-forge` for local development $ git clone git@github.com:your_name_here/growth-forge.git ``` -3. Install your local copy into a conda virtual environment: +3. **Install Dependencies**: Use `mamba` to create a Conda environment and`poetry` for managing Python dependencies. ```bash $ cd growth-forge/ # in the case you are not in the root of the project @@ -104,7 +104,61 @@ $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature ``` -7. Submit a pull request through the GitHub website. +7. Submit a pull request through the GitHub website. + +## Configurations before working on Growth-Forge + +1. If you don't have Docker installed, you can visit the following page: + [click here](https://docs.docker.com/engine/install/ubuntu/) and follow the + steps. Do not forget to see the steps of post install + [here](https://docs.docker.com/engine/install/linux-postinstall/) + +2. Run the following command: + +```bash +$ sugar build +``` +3. It is important to run the command: + +```bash +$ makim django.migrate +``` +This command is executed to apply migrations based on the current migration files. + +4. To create a superuser, you should use the following commands with your information: + +```bash +$ makim django.create-superuser --email +$ makim django.create-superuser --username +$ makim django.create-superuser --password +``` + +5. Run the comand to execute Django: + +```bash +$ sugar ext start --options -d +``` + +or + +```bash +$ sugar ext restart --options -d +``` + +The project will be accessible at `localhost:8000`. + +6. To view all logs, you can execute the following command: + +```bash +$ sugar ext restart --options +``` + +The command mentioned is used to restart the project, which can be useful when registering a new user. + +After adding a new user, you should check the console for the email verification link. To complete the email verification, click on the link, which will open in your browser. There, you will see the option to verify the email. This step is crucial to ensure the email address is valid and active, enabling the new user to fully utilize their account. + +7. Once you have accessed the verification link and verified your email, you can navigate through the menu of the project "growth-forge." This menu will likely offer various options related to project settings. + ## Pull Request Guidelines