mugishap / qtask Goto Github PK

This is a task management app created in ReactJS and NestJS.

• About
• Getting Started
• Deployment
• Usage
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments
• License
• Project Structure

The purpose of this project is to create a task management app that allows users to create, edit, and delete tasks. The app is built using ReactJS and NestJS. The frontend is built using ReactJS and the backend is built using NestJS. The frontend and backend are connected using REST API. The frontend is deployed using Vercel and the backend is deployed using Render.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

What things you need to install the software and how to install them. -Node v18.0.0 -NPM

A step by step series of examples that tell you how to get a development env running.

Clone the repo

git clone https://github.com/mugishap/qtask.git

And then install the dependencies

cd frontend-service & yarn install
cd backend-service & yarn install

Then run the project on your local machine

    cd frontend-service & yarn start
    cd backend-service & yarn start

To use the system you will acess the live deployment online using this link or you can run the project on your local machine by following the steps above.

For Deploymnent and CI/CD you can use Docker to deploy the app on a live system.

• PostgreSQL - Database
• NestJS - Server Framework
• ReactJS - Web Framework
• TailwindCSS - Styling Library

• @mugishap - Idea & Initial work

• Inspiration
• References