# Index

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

# About The Project

The Statch Project Manager is designed to help teams effectively manage their projects and tasks. It provides a range of features including the ability to create and manage projects, assign tasks to team members, track progress, collaborate in real-time, and monitor project performance and resource utilization.

(back to top)

# Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Angular - A typescript framework, is a platform for building mobile and desktop web applications
• Typescript - A typed superset of JavaScript that compiles to plain JavaScript
• NodeJS - A JavaScript runtime built on Chrome's V8 JavaScript engine
• NestJS - A progressive Node.js framework for building efficient, scalable, and enterprise-grade server-side applications
• SQLite - SQLite is a C-language library that implements a small, fast, self-contained, high-reliability, full-featured, SQL database engine.
• Prisma - Prisma Client is a query builder that’s tailored to your schema. We designed its API to be intuitive, both for SQL veterans and developers brand new to databases.

(back to top)

# Getting Started

# Prerequisites

To get started with the Statch, you'll need to have the following software installed on your machine:

• NodeJS 18.12.1
• SQLite
• Prisma CLI 4.9.0
• NestJS CLI 9.1.9

# Installation

1. Clone the repo

   git clone https://github.com/Half-Square/Statch.git

2. Install the dependencies

   npm run setup # or yarn

# Run project

1. Start the front end development server

   npm run start:client # or yarn 

2. Start the back end server

   npm run start:server # or yarn 

# Build project

1. Build server

   npm run build:full # or yarn 

(back to top)

# Usage

To use the Statch Project Manager, follow these steps:

1. Create a new project by clicking the "New Project" button in the top right corner of the dashboard.
2. Add tasks to the project by clicking the "Add Task" button on the project page.
3. Assign tasks to team members by clicking the "Assign" button on the task card.
4. Monitor progress by viewing the task list on the project page.
5. Collaborate with team members in real-time using the in-app comment feature.

(back to top)

# Roadmap

We have a number of features planned for future releases of the Statch Project Manager. These include:

• Add Changelog
• Mobile app for iOS and Android
• Monitor project performance and resource utilization using the various graphs and charts available on the dashboard.
• Multi-language Support
  • French

See the open issues for a full list of proposed features (and known issues).

(back to top)

# Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

# License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

# Contact

Half Square - Website or contact@halfsquare.fr

Project Link: https://github.com/Half-Square/Statch

(back to top)