Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.07 KB

File metadata and controls

44 lines (34 loc) · 2.07 KB

Commands

Download the software in your local machine

Clone this repository
git clone https://github.com/pSN0W/notes-generator.git

Start backend server

Install pip3 if not installed already
sudo apt install python3-pip

Install virtualenv if not installed already
pip install virtualenv

Go to the project
cd notes-generator

Go to backend directory
cd backend/

Create virtual environment
python3 -m venv env

Activate virtual environment
source env/bin/activate

Install related packages
pip3 install -r requirments.txt

Ready your database for migration
python3 manage.py makemigrations

migrate
python3 manage.py migrate --run-syncdb

Start your backend development server
python3 manage.py runserver

Make sure your development server is running

Start frontend server

Create one for instance of terminal at notes-generator

Go to frontend directory
cd frontend

Install all the necessary packages
npm install

Start your development server
npm start

Once both your frontend and backend development server has successfully started search http://localhost:3000/ in your browser.
You will see home page of Notesy.

Creating first note

First step is to create an account for yourself.
Click on the User icon on top right of the page and then click sign up on the login page. Or just search for http://localhost:3000/register in your browser.
Provide relevant information to create the User.
Once the user has been registered successfully you will be redirected to homepage.
Click on Notes on the top right of home page and select Create Notes.

Create your note and the click on Save and Create option on top task bar.

Hurray!! you have created your first Note.