Follow this guide to set up the project:
- Clone NexONG-backend repository by executing
git clone https://github.com/ISPP-G5/NexONG_Backend.gitin the directory of your choice.
- Install virtualenv
pip install virtualenv. - In the root directory of the project you just cloned, create the virtual environment by running
python3 -m venv myenv, myenv being what you want to name the virtual environment. - Activate your new virtual environment with
source venv/bin/activate.
You can create the Windows virtual environment by running commands as in Linux following this guide. However, I think the easiest option is creating it through VSCode.
- Open the cloned project in VSCode.
- Press
ctrl+shift+pon your keyboard. - Select the option
Python: Select Interpreter. - Press
+ Create Virtual Environment. - Select
Venv. - Select
Python 3.11 - If there is a pop-up about the requirements, just press
OK. - If you see that it is not activated automatically, close the VSCode window and open it again.
- When it is activated, you should be able to see
(.myenv)on the terminal, something like this:
- Install project dependencies by running
pip install -r requirements.txtin the project's root folder.
- Install postgres running
sudo apt install postgresql. - Access the postgres instance with
sudo su - postgres. - Create the user for the database
psql -c "create user nexong with password 'nexong'". - Create the database
psql -c "create database nexongdb owner nexong". - Set the role
psql -c "ALTER USER nexong CREATEDB".
- Install postgres on your machine from the official website.
- Access the installation folder
C:\Program Files\PostgreSQL\16\binand executepsql -U postgres. - Create the user for the database
CREATE USER nexong WITH PASSWORD 'nexong';. - Create the database
create database nexongdb owner nexong;. - Set the role
ALTER USER nexong CREATEDB;.
You can check if the database is correctly created using \l in the psql instance
In the root folder of the project, run:
python manage.py makemigrations nexongpython manage.py migratepython manage.py loaddata populate.json
In the root folder of the project, run:
python manage.py runserver- Access to the DEMO API on
http://127.0.0.1:8000/api/
To consult the API's Swagger documentation you can check it in http://127.0.0.1:8000/docs while the app is running.
It's not unusual for the database to change. This causes an error, which usually, looks like this:
This happens because the migrations that were used to create the DB don't apply anymore. The solution is quite straightforward. Instead of executing the same commands every time and waste time, let's make shell scripts:
- Open the backend project in VSCode and create the folder
.vscodein the root folder. It should look like this:
- Create a file called
drop_db.shinside.vscodeand paste this inside it:
#!/bin/bash
# Define PostgreSQL database name
DB_NAME="nexongdb"
# Prompt for sudo password
echo "Please enter your sudo password:"
read -s SUDO_PASSWORD
# Stop PostgreSQL service
echo "$SUDO_PASSWORD"
# Drop PostgreSQL database
sudo -u postgres psql -c "DROP DATABASE IF EXISTS $DB_NAME;"
sudo -u postgres psql -c "create database $DB_NAME owner nexong"
sudo -u postgres psql -c "ALTER USER nexong CREATEDB"
echo "Database '$DB_NAME' has been deleted successfully."- Then, create another file in the same folder as
drop_db.shcalledmigrations.shand paste the following code inside it:
#!/bin/bash
# Install requirements
pip install -r requirements.txt
# Delete previous migrations
rm -rf nexong/migrations
# Make migrations
python manage.py makemigrations nexong
# Migrate
python manage.py migrate
# Create superuser
python manage.py createsuperuser
#Loaddata
python manage.py loaddata populate.json
# Run server
python manage.py runserver- Make both scripts executable by running this in the
.vscodedirectory:
chmod +x drop_db.sh
chmod +x migrations.sh- Finally, run first the
drop_db.shscript and then themigrations.shscript. To run them, go to the.vscodedirectory, executedrop_db.shormigrations.shin the terminal.
- Create a file called
drop_db.batinside.vscodeand paste this inside it:
@echo off
cd /d "C:\Program Files\PostgreSQL\16\bin"
echo Changing directory to PostgreSQL bin folder...
echo.
set PGPASSWORD=your_postgres_password
echo Dropping existing PostgreSQL database if it exists...
echo.
psql -U postgres -c "DROP DATABASE IF EXISTS nexongdb;"
echo.
echo Creating PostgreSQL database...
echo.
psql -U postgres -c "CREATE DATABASE nexongdb WITH OWNER nexong;"
echo.
echo PostgreSQL database created successfully.
cd /d "C:\Your_backend_project_root"
echo Changing directory to the project root...
echo.- Then, create another file in the same folder as
drop_db.batcalledmigrations.batand paste the following code inside it:
@echo off
echo Going back one directory...
cd ..
echo Deleting "migrations" folder in "/root/nexong"...
rd /s /q "nexong\migrations"
echo Installing requirements...
pip install -r requirements.txt
echo Running "python manage.py makemigrations nexong"...
python manage.py makemigrations nexong
echo Running "python manage.py migrate"...
python manage.py migrate
echo Running "python manage.py loaddata populate.json"...
python manage.py loaddata populate.json
echo All steps completed successfully.Note: if you want you can add python manage.py runserver at the end of the script or python manage.py createsuperuser after the populate command
- Finally, run first the
drop_db.batscript and then themigrations.batscript. To run them, go to the.vscodedirectory, executedrop_db.batormigrations.batin the terminal.
In this way, the usual problem of DB modification is solved.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent