Skip to content

kimlimjustin/google-keep-clone

Repository files navigation

Google Keep Clone

Try it online here!

Demo

Theme / View Light Theme Dark Theme
Grid Google Keeps Clone demo Google Keeps Clone demo
List Google Keeps Clone demo Google Keeps Clone demo
For the best experience, please use a device with a width of at least 350px

Built using:

  • Python with Django framework and Jinja templating language
  • Vanilla JavaScript

Getting started:

  • Clone this repository or fork it
    • To clone this repository, type git clone https://github.com/kimlimjustin/google-keep-clone.git on your terminal
    • To fork this repository, click fork button of this repository then type git clone https://github.com/<your username>/google-keep-clone.git
  • Install all the dependencies of this project by typing pip install -r requirements.txt on your terminal.
  • Migrate the database by typing python manage.py migrate on the terminal.
  • Run this project
    • Run the project locally by typing python manage.py runserver on the terminal and it will be accessible in your localhost.
    • To run it on your local network, type python manage.py runserver 0.0.0.0:8000 and it will be accessible in your local network.
  • To deploy this project, remember to run python manage.py collectstatic

On Running Docker

  1. Build docker image using docker-compose build and run using docker-compose up
  2. When running any command like python manage.py collectstatic, just add docker-compose exec web <command>
  3. It has postgresql, so you can access with docker-compose exec db psql -U postgres

License

Distributed under the MIT License. See LICENSE for more information.

Contact