Skip to content

Latest commit

 

History

History
122 lines (102 loc) · 3.1 KB

README.md

File metadata and controls

122 lines (102 loc) · 3.1 KB
Raw

Capsule-Notes

Notes-App — Note-Taking Asynchronous-Project on FastAPI

A cloud-based note-taking application designed to help users conveniently create, name, and save notes for later use. This tool is ideal for managing personal records and organizing thoughts effectively.

Stack:

  • Pyhton
  • FastAPI
  • SQLAlchemy
  • SQLite
  • Pytest
  • Jinja2
  • Redis | Celery | Flower

Additional libraries are specified in the requirements.txt file.

Project Setup on Windows

- Installing the Stack

To begin, install: Python
Links are provided to the latest version of the tools.

- Cloning a Project from GitHub

Create a root directory on your computer, then open it in your code editor or terminal.
Next, write this command into the command line:

git clone https://github.com/S0fft/Capsule-Notes.git .

You will see the project files appear in your directory.

- Creating a Virtual Environment

Create a virtual environment:

python -m venv .venv

And activate it:

.venv\Scripts\Activate

- Installing the Requirements

Next, install packages:

python.exe -m pip install --upgrade pip
pip install -r requirements.txt

- Applying the Migrations

Run the following command in the terminal; this will create the folder structure and the configuration file alembic.ini:

alembic init migrations

Now you can create a new migration by running the following command:

alembic revision --autogenerate -m "initial migration"

- Running the Server

Then, run server:

uvicorn main:app --reload

After starting the server, you can access the application by navigating to http://127.0.0.1:8000 in your browser.

Project Setup on Unix-Like Systems

These commands do the same thing as described above:

- Installing the Stack

To begin, install: Python
Links are provided to the latest version of the tools.

- Cloning a Project from GitHub

Create a root directory on your computer, then open it in your code editor or terminal.
Next, write this command into the command line:

git clone https://github.com/S0fft/Capsule-Notes.git .

You will see the project files appear in your directory.

- Creating a Virtual Environment

python3 -m pip install --upgrade pip
source ./venv/bin/activate

- Installing the Requirements

pip install --upgrade pip
pip install -r requirements.txt

- Applying the Migrations

Run the following command in the terminal; this will create the folder structure and the configuration file alembic.ini:

alembic init migrations

Now you can create a new migration by running the following command:

alembic revision --autogenerate -m "initial migration"

- Running the Server

uvicorn main:app --reload

After starting the server, you can access the application by navigating to http://127.0.0.1:8000 in your browser.