Free Notes is a web application to create dynamic free notes, written in Python and built on Aurora framework.
It is an MVC web application based on REST architecture.
It uses Vanilla JavaScript for the front-end development.
You can find all the dependencies for this project at the end of this file.
Please note that this project is created for testing the functionality of the Aurora framework. You can find a detailed documentation for aurora framework on Aurora Docs.
- Free Notes is a responsive, mobile-first web application.
- It is a multi-user web application, with a Login/Register system.
- Users can create dynamic notes using a WYSIWYG HTML editor.
- Users can manage all their notes and perform some actions to them.
- Users can edit and delete their notes.
- Each user can only access to their own notes.
- It uses SQLite database for managing the application data.
- It is a RESTFUL web application.
- It uses JavaScript to send forms to the server.
- It uses a CSRF token for forms to protect against CSRF attacks.
In addition to the errors app and aurora app that comes with the Aurora framework,
It has two other apps:
- users: For login, register and logout the users.
- notes - For create, update and delete notes for the users.
The controllers directory contains all the controllers for all the apps. Each app has its own subdirectory that contains all the controller classes of that application.
Each controller class can provide up to four RESTFUL CRUD methods:
| CRUD Methods | HTTP Methods | Controller Methods |
|---|---|---|
| Create | POST | post |
| Read | GET | get |
| Update | PUT | put |
| Delete | DELETE | delete |
For forms I have used only the CSRF attribute of WTForms, and have validated forms via python code.
To initialize the database run the following command:
(venv) python manage.py init-db
This application uses two models:
- Users - Which is responsible to manipulate the
userstable of the database. - Notes - Which is responsible to manipulate the
notestable of the database.
These models are AuroraSQL models.
Each application has its own static files inside the statics directory.
There is also a subdirectory called assets which is used for all the apps.
Each application has its own view files inside the views directory.
Each view file is an HTML like Jinja2 template.
_apps.pyis a system module from Aurora framework that contains a python collection of all installed apps.app.pymodule is used for instantiate the root app of Aurora framework, to serve all the child apps and run the server.config.pyis the configuration module for the whole project.manage.pymodule is the CLI application of Aurora framework.app.dbis the SQLite database file created by Aurora framework.