Skip to content

Latest commit

 

History

History
77 lines (41 loc) · 1.45 KB

README.md

File metadata and controls

77 lines (41 loc) · 1.45 KB
Raw

ErisedStory

Versions/Environment

node v21.6.2 (tested on node v19 and it works) npm v10.2.4 python 3

Frontend

Download

For frontend, you may need to download node.js 20 +. After downloading it, enter the /frontend folder in your terminal and install all the dependencies

cd PATH_TO_THE_PROJECT  # enter the project folder
cd /frontend
npm install

After installing the dependencies, create a .env file (In VSCode, you can write click the the /frontend folder and select "NEW FILE" and then name it as ".env").

Write following line to .env file

REACT_APP_BACKEND_HOST="http://localhost:8001"
PORT=3000

Project folders

Under the frontend folder, add your code into /src folder

/src/App.js The entrance of the application, set routes in this project

/src/App.css Global css settings

Backend

Download

Enter the /backend folder, create a python environment using Pyton==3.8 and download dependencies

cd /backend
conda create --name erised_env python=3.9
conda activate erised_env
pip install -r requirements.txt
python manage.py runserver 8001

Create a .env file and put your environment variables(sensitive information here)

OPENAI_API_KEY="sk-...."

Project folders

/backend/users All the backend api for users login/logout

/backend/story_line All the other api for this project

/backend/story_line/ai_models/openai_api.py The method to make requests to openai