https://github.com/omar-muhamad/project-management-app-ts

https://github.com/omar-muhamad/project-management-app-ts

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/omar-muhamad/project-management-app-ts
• Owner: Omar-Muhamad
• License: mit
• Created: 2023-03-24T21:58:50.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-05-03T08:08:06.000Z (over 1 year ago)
• Last Synced: 2024-11-09T01:34:04.057Z (2 months ago)
• Language: TypeScript
• Homepage: https://project-management-app-ts.vercel.app
• Size: 417 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

  

  


  
Project Management App




# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Project Management App ](#-project-management-app-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [🚀 Live Demo ](#-live-demo-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 Project Management App 

> Testing React with vite instead of Webpack

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

    
next.js

  


  Backend

  


    
next.js

  


  Database

  


    
PostgreSQL

  


### Key Features 

- **Create a new app using Next.js**

- **Create a PostgreSQL database using Prisma**

- **Use the new App router feature in Next.js 13.2 which built on top of React Server Components**

- **Add JWT Authentication to the app**

- **Add project pages**

- **Add project API routes and endpoints**

- **Style the app using TailwindCSS**

- **Deploy the app on Varcel**

(back to top)


## 🚀 Live Demo 

Here is the [Live Demo Link](https://project-manag.vercel.app/) of the app on varcel.com.

(back to top)


## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

- Install [Node.js](https://nodejs.org/en/).

- Code editor e.g. [VS code](https://code.visualstudio.com/download).

- Version Control System e.g. [git-scm](https://git-scm.com/downloads).

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/Omar-Muhamad/Project-Management-App.git

```

### Install

Install this project with:

```sh

  cd my-project

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run dev

```

### Run tests

> Comming Soon

### Deployment

To run the production build, execute the following command:

```sh

  npm run build

  npm start

```

(back to top)


## 👥 Authors 

🧑‍💻 **Omar Muhammad**

- GitHub: [@Omar-Muhamad](https://github.com/Omar-Muhamad)

- Twitter: [@Eng_OmarMuhamad](https://twitter.com/Eng_OmarMuhamad)

- LinkedIn: [eng-omarmuhammad](https://linkedin.com/in/eng-omarmuhammad)

(back to top)


## 🔭 Future Features 

- [ ] **Add email and Oauth (google and github) authentication using Next auth**

- [ ] **Edit Auth pages(sign in and sign up) layout**

- [ ] **Edit project page styling**

- [ ] **Add tasks component, API endpoint, and Modal**

- [ ] **Add the remaining features on the side navbar**

- [ ] **Add dark theme**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

> If you like this project give us a star.

(back to top)


## 🙏 Acknowledgments 

I would like to thank React and Vite dev team for wonderful documentation.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)