Notes

Description

A simple web-app to create, edit, delete and share notes with your friends! Made with FastAPI

Setup

1. Clone the repository
   
2. Make sure to install all the dependencies listed in requirements.txt within the project directory

    pip install -r requirements.txt

3. Create a .env file within the \NotesApp directory, then copy the output of the following command

   openssl rand -hex 32

   Within the .env file, write the following (remove the angle braces) and replace OUTPUT with the above

   SECRET_KEY=<OUTPUT>

4. Run the fastapi server by changing your current working directory into NotesApp

   cd NotesApp/
   fastapi dev main.py

5. You've successfully started the app!

Docker

1. If you would like to run the app off of a container, follow all setup steps from 1-3.
2. Change your working directory to Notes/ and build the docker image

   docker build -t img_name .

   If you would like to have your current database on the container, edit the .dockerignore file and remove 'NotesApp/database.db' before building the image
3. Run the docker container

   docker run -d -name container_name -p 80:80 img_name

File structure

Notes
    │   .dockerignore
    │   .gitignore
    │   Dockerfile
    │   README.md
    │   requirements.txt
    │
    └───NotesApp
        │   .env
        │   crud.py
        │   database.db
        │   main.py
        │   models.py
        │   security.py
        │   __init__.py
        │
        └───templates
                friends.html
                home.html
                login.html
                new_note.html
                note.html
                register.html
                update_note.html