Markdown note-taking app using React.js and Python.
GPL-3.0 License
Clone this repo to your local machine using git clone https://github.com/yeyeto2788/NoteDown
Install Python requirements. 💻
cd ./NoteDown/python_api
pip install -r requirements
Install Nodejs requirements :electron:
cd ../react_app
npm install
npm run build
npm run postbuild
Serve the application using python 🐍
cd ..
cd ./python_api
python run.py
Build the images 💿
docker build --tag notedown_fe_image -f ./deployment/notedown_fe.dockerfile .
docker build --tag notedown_api_image -f ./deployment/notedown_api.dockerfile --build-args NOTEDOWN_DB_URL=<url_of_your_db> .
For database URL on the API you need to follow the syntax described here.
Run the container 📦
docker run -p 80:3000 -d --name notedown-fe notedown_app_image
docker run -p 8080:8080 -d --name notedown-api notedown_api_image
Inspect the container 🔍
docker exec -it notedown-app /bin/bash
docker-compose --file ./deployment/docker-compose.yml up --force-recreate --build
No frequently asked question yet. 😐
Reach out to me at one of the following places!
utils
module.Dockerfile
docker-compose.yml
so every component can be deployed separately (DB, FE, BE)README
.Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
git checkout -b feature/super_awesome_feature
)git commit -m 'Add some awesome feature'
)git push origin feature/super_awesome_feature
)See LICENSE
for more information.