Skip to content

Ketan-coder/NoteTakingApp

Repository files navigation

Timely: Notebook Web App 📝

Screenshot Timely is a simple and efficient note-taking web app built with Django.
It allows users to create, edit, and organize notes effectively.

Running at (for now): Timely

Features

✅ Create and edit notes
✅ Organize notes into notebooks
✅ Set reminders
✅ Simple and intuitive UI
✅ and many more coming in updates

Installation

  1. Clone the repository:

    git clone https://github.com/Ketan-coder/NoteTakingApp.git
  2. Navigate to the project directory:

    cd NoteTakingApp/Timely
  3. Install dependencies:

    pip install -r requirements.txt
  4. Run migrations:

    python manage.py makemigrations
    python manage.py migrate
  5. Run the development server:

    python manage.py runserver

2️⃣ Running with Docker 🐳

If you want to run this project using Docker, follow these steps:

  1. Ensure Docker is installed on your system. If not, install it from Docker's official website.

  2. Clone the repository (if not already done):

    git clone https://github.com/Ketan-coder/NoteTakingApp.git
    cd NoteTakingApp/Timely
  3. Build the Docker image:

    docker build -t timely-app .
  4. Build the Docker Container (Optional):

    docker-compose up --build
  5. Run the container:

    docker run -p 8000:8000 timely-app
  6. Access the app in your browser:

    http://localhost:8000
    

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published