https://github.com/rangerdigital/march
Typescript - Nest.js - TypeORM
https://github.com/rangerdigital/march
Last synced: over 1 year ago
JSON representation
Typescript - Nest.js - TypeORM
- Host: GitHub
- URL: https://github.com/rangerdigital/march
- Owner: RangerDigital
- Created: 2023-05-28T21:25:52.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-29T13:08:42.000Z (about 3 years ago)
- Last Synced: 2025-01-29T14:16:14.548Z (over 1 year ago)
- Language: TypeScript
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
[](https://www.gnu.org/licenses/gpl-3.0)
Tasko is a simple yet powerful Task Management system developed using **NestJS**.
This project aims to provide an easy way to manage tasks and their respective assignees. It includes a robust authentication system, and uses SQLite as the database backend.
> 🚧 Tasko is a minimalistic solution, suitable for personal projects and learning purposes!
## 🛠 Operating Principle
Tasko provides APIs to create, update, delete and fetch tasks. It also includes user management and authentication features.
The project uses TypeORM to interface with the SQLite database, and Passport.js for authentication (JWT strategy).
> 🚧 You are responsible for securing your own deployment!
## 🔥 Installation
Clone this repository to your local machine:
```bash
git clone https://github.com/yourusername/tasko.git
```
Install the required packages:
```bash
npm install
```
## 🎉 Usage
You should start by running the NestJS server:
```bash
npm run start
```
Then you can access the APIs at `localhost:3000`.
### User Management
You can register a new user by sending a POST request to `/auth/signup` with the following body:
```json
{
"name": "username",
"email": "email@example.com",
"password": "yourpassword"
}
```
### Task Management
You can manage tasks by using the `/tasks` endpoint.
Authentication is required for these operations. You can get a JWT by sending a POST request to `/auth/signin`.
> 💡 Check out the `controllers` and `services` directories for more details about the endpoints!