Project Planner

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation

About The Project

This is a simple web app that allows users to plan out projects and keep track of tasks.

Built With

• React.JS
• React Router
• TypeScript
• Flask
• PostgreSQL

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

   git clone https://github.com/jaydenkwright/project-planner.git

2. Install Python packages

   pip install -r requirements.txt

3. Install NPM packages

   cd client
   npm install

4. Run web server

   python main.py

5. Run React Dev Server

   cd client
   npm run start

Contributing

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request