diff --git a/README.md b/README.md index fd6583bf1006d33d5d859e8d08b4fa995bc84da4..e44deb5d232f0997cb897afa4786b8003babc2e3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,65 @@ -# Walkiddie Toys -BackEnd - [](https://gitlab.cs.ui.ac.id/ppl-fasilkom-ui/2021/CC/walkiddie.toys/walkiddie-toys-backend/-/commits/staging) [](https://gitlab.cs.ui.ac.id/ppl-fasilkom-ui/2021/CC/walkiddie.toys/walkiddie-toys-backend/-/commits/staging) -## Kontributor +# Walkiddie Toys - BackEnd +The first crowdfunding platform in the toys industry. -Nama kelompok : Narai -Kelas : C -Anggota : +### Contributors +Group : Narai +Class : C +Members : - Aji Inisti Udma Wijaya - 1806141126 - Muhamad Adhytia Wana Putra Rahmadhan - 1806141321 - Muhammad Ihsan Azizi - 1806186774 - Naufal Alauddin Hilmi - 1806205754 -- Ronaldi Tjaidianto - 1806141441 \ No newline at end of file +- Ronaldi Tjaidianto - 1806141441 + +### Setup Environment + +1. Clone walkiddie-toys-backend repository + +``` +git clone https://gitlab.cs.ui.ac.id/ppl-fasilkom-ui/2021/CC/walkiddie.toys/walkiddie-toys-backend.git +``` + +2. Get into project folder + +``` +cd walkiddie-toys-backend +``` + +3. Activate a Python virtual environment + +``` +virtualenv venv +venv\Scripts\activate +``` + +4. Install required packages + +``` +pip install -r requirements.txt +``` + +5. Create a `.env` file inside the root project, write the variables below: + +``` +PASSWORD_UNIT_TEST={random_password_for_testing_purposes} +EMAIL_HOST_PASSWORD={your_email_app_password} +SECRET_KEY=4znq={django_secret_key} +SOCIAL_AUTH_GOOGLE_OAUTH2_KEY={google_auth_key} +SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET={google_auth_secret} +REDIRECT_FRONTEND_URL={url_of_frontend_app} +``` + +6. Do database migrations + +``` +python manage.py migrate +``` + +7. Run + +``` +python manage.py runserver +``` \ No newline at end of file