thebugged / notes-app Goto Github PK

Notes App

A simple notes app.

Prerequisites

Ensure the following are installed;

• Git
• Node.js
• Python (3.x)

To set up this project locally, follow these steps:

Windows

1. Clone the repository:

git clone https://github.com/thebugged/notes-app.git

2. Create a virtual environment:

python -m venv venv

3. Activate the virtual environment:

venv\Scripts\activate

4. Install the Python dependencies:

pip install -r requirements.txt

5. Install the Node.js dependencies:

cd frontend
npm install

or

npm install --force

macOS/Linux

1. Clone the repository:

git clone https://github.com/thebugged/notes-app.git

2. Create a virtual environment:

python -m venv venv

3. Activate the virtual environment:

source venv/bin/activate

4. Install the Python dependencies:

pip install -r requirements.txt

5. Install the Node.js dependencies:

cd frontend
npm install

From project directory run the Django development server:

python manage.py runserver

The app will be accessible at http://127.0.0.1:8000/.