A project management app that enables people and teams get more done by effectively managing their projects and tasks.
PROJECT LIVE LINK
HOW TO RUN THE APP
TECH STACK
SPECIAL GOTCHAS
CONTRIBUTING
SPREAD THE WORD
AUTHOR
Visit https://cleartask.crunchgarage.com/
Clone this repository
Using SSH
git clone git@github.com:mutuaMkennedy/cleartask.git
or
Using HTTPS
git clone https://github.com/mutuaMkennedy/cleartask.git
Install docker and docker compose if you haven't done so. Installation instructions can be found here
Then navigate to the base directory of the project and create .env file based on the env.sample file provided on the project directory,
then run the following command
docker compose -f docker-compose-dev.yml up --build
If you are want to build images from the production docker compose file, make sure you setup your ssl certificates to avoid errors.
Or, just use the none SSL enabled nginx conf file by doing the following.
Open
docker-compose-prod.yml
find the Nginx block and change
- ./services/nginx/production:/etc/nginx/conf.d to - ./services/nginx/development:/etc/nginx/conf.d
then run this command
docker compose -f docker-compose-prod.yml up --build
DOCKER IMAGES ARE ALSO AVAILLABLE
Don't have time to setup things? Pull the production ready docker images instead.
Run the following commands
docker compose -f docker-compose-prod.yml pull
then run the project with
docker compose -f docker-compose-prod.yml up
Here's a brief high-level overview of the technologies used on this project:
- Python, Django and Django restframework for the backend.
- React JS for the front end.
- PostgreSQL database
- Docker and docker compose to package and run the all the services together.
- AWS EC2 for hosting.
- AWS RDS to manage the database. Its generally a bad idea to manage a database in a docker container.
- AWS ECR to host the docker images
- If it matters to someone UI designs are made in Figma. Will share attach those later when the project has advanced.
Most of my previous work has been done with Python, Django, JQuery, and Materialize CSS as my primary stack.
I had previously worked with react JS but had never delved deeply into it. This project allows me to experiment
with new technologies such as React and Docker.
I also create all of my designs, including the logos and any graphical elements you might see on this or any
of my projects. Figma for UI/UX and Adobe Illustrator for logos and any graphical or presentation work are my
primary design tools.
This is an ongoing project that is not yet completed. I'm constantly designing and improving the features. Keep an eye out for new feature releases.
Interested in contributing to this project? Thanks so much for your interest! We are always looking for improvements to the project and contributions from open-source developers are greatly appreciated.
Feel free to fork and contribte to this project from
CRUNCHGARAGE
If you want to say thank you and/or support active development of this project:
- Add a GitHub Star to the project!
- Check out our website Crunch Garage and GitHub
Thanks so much for your interest in growing the reach of this project!
Mutua Kennedy | Visit my website
Also have a look at Crunch Garage