nimiology / savile

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project Name: Note Taking App

This project is a web-based note-taking application that allows users to add and access their notes from any device with internet access. The application provides a user-friendly interface to create, view, and manage notes.

Installation

To install and run the Note Taking App locally, follow these steps:

  1. Clone the repository to your local machine:
git clone https://github.com/nimiology/savile.git
  1. Navigate to the project directory:
cd note-taking-app
  1. Create and activate a virtual environment (optional, but recommended):
python3 -m venv env
source env/bin/activate
  1. Install the required dependencies:
pip install -r requirements.txt
  1. Set up the database:
python manage.py migrate
  1. Start the development server:
python manage.py runserver
  1. Access the application by visiting http://localhost:8000 in your web browser.

Features

  • Create new notes with a title and optional description.
  • Upload and attach files to your notes.
  • View the details of each note, including its title, description, and attached file (if any).
  • Access your notes from any device with internet access.
  • User-friendly interface for an intuitive note-taking experience.

Technologies Used

  • Python
  • Django (web framework)
  • HTML

Contributing

Contributions to this project are welcome. If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on the GitHub repository.

If you would like to contribute to the project, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push the changes to your forked repository.
  5. Submit a pull request to the original repository.

License

This project is licensed under the MIT License.

Contact

For any inquiries or questions, please contact nimiologyy@gmail.com.

About

License:MIT License


Languages

Language:Python 91.9%Language:HTML 8.1%