https://github.com/showrin/drf-react-aws-deployment
A test project created using django rest framework, reactjs for learning AWS deployment
https://github.com/showrin/drf-react-aws-deployment
css django-rest-framework python3 reactjs
Last synced: 2 months ago
JSON representation
A test project created using django rest framework, reactjs for learning AWS deployment
- Host: GitHub
- URL: https://github.com/showrin/drf-react-aws-deployment
- Owner: Showrin
- Created: 2023-04-21T19:32:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-04T16:18:12.000Z (about 3 years ago)
- Last Synced: 2025-12-26T20:14:50.195Z (6 months ago)
- Topics: css, django-rest-framework, python3, reactjs
- Language: Python
- Homepage:
- Size: 411 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# drf-react-aws-deployment
## Table of Content
- [drf-react-aws-deployment](#drf-react-aws-deployment)
- [Table of Content](#table-of-content)
- [How to run the Backend App locally](#how-to-run-the-backend-app-locally)
- [Initialize the DB](#initialize-the-db)
- [Setup Virtual Environment for backend](#setup-virtual-environment-for-backend)
- [Declare Environment Variables](#declare-environment-variables)
- [Migrating our Database](#migrating-our-database)
- [Run the project :rocket:](#run-the-project-rocket)
- [How to run the frontend App locally](#how-to-run-the-frontend-app-locally)
- [Declare Environment Variables](#declare-environment-variables-1)
- [Run the project :rocket:](#run-the-project-rocket-1)
## How to run the Backend App locally
### Initialize the DB
Here we used PostgreSQL as the DB. To run our project locally, we have to setup PostgreSQL first. You can follow the following steps:
1. Download the PostgreSQL from [**here**](https://www.postgresql.org/download/) for the OS you're using. You can choose the PostgreSQL version **14 or above**.
2. Now you can open the **pgAdmin App**.
3. From the left sidebar, you can click on **Servers** > **PostgreSQL 14** > **Databases**.
4. Now click right mouse button on **Databases** and select **Create** > **Database** from the list. A modal will open.
5. Provide the name of the database. We used **`api`** as the name. You can use other name. **But, remember you have to use that name in the .env file in later section.**
6. Select the owner. **Remeber, you have to provide the password of that owner while accessing the database**.
7. And **Save**. Our DB is ready to use.
### Setup Virtual Environment for backend
We've used Python in our backend app. To run the backend server, we've to create a virtual environment first. Run the following commands.
```
cd ./backend/
py -3 -m venv .venv
```
After running these commands, a virtual environment will be created in this location -> `/backend/.venv`. Now we have to activate the environment from the terminal. Run the following command (make sure you're in the `backend` directory).
```
./.venv/Scripts/activate
```
Our virtual env will be started. Then we have to install all the packages that are being used in our backend app.
```
pip install -r requirements.txt
```
The above command will install all the packages mentioned in `requirements.txt` file. And our environment is ready to use.
### Declare Environment Variables
Now, we've to define all of our environment variables used in our backend app. We can get all the variables from the `backend/.env.example` file.
1. First, we've to create a file `.env`.
2. Copy all the variables inside `.env.example` file and paste them in `.env` file.
3. Now, populate these variables with proper value.
### Migrating our Database
We're just one step behind to run our app. We've created our database in an earlier step. But our DB is now empty.
1. So we've to create necessary tables. To do that, run the following command.
```
python manage.py migrate
```
2. Then we have to populate our table with some initial data. Run the following command for seeding data.
```
python manage.py loaddata seeds/quotes.json
```
This will populate some quotes in the quotes table.
### Run the project :rocket:
Finally, we're ready to run the backend. Run the following command.
```
python manage.py runserver
```
## How to run the frontend App locally
### Declare Environment Variables
We've to define all of our environment variables used in our frontend app too. We can get all the variables from the `frontend/.env.example` file.
1. First, we've to create a file `.env`.
2. Copy all the variables inside `.env.example` file and paste them in `.env` file.
3. Now, populate these variables with proper value.
4.
### Run the project :rocket:
Finally, we're ready to run the frontend. Run the following command.
```
yarn
yarn start
```