https://github.com/ismacortgtz/fasty-task-server

Backend API for fasty-task, an app to manage your schol life.
https://github.com/ismacortgtz/fasty-task-server

api back expressjs fasty-task mongodb nodejs schedule school task-manager

Last synced: 3 days ago
JSON representation

Backend API for fasty-task, an app to manage your schol life.

• Host: GitHub
• URL: https://github.com/ismacortgtz/fasty-task-server
• Owner: IsmaCortGtz
• License: gpl-3.0
• Created: 2023-12-31T02:17:37.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-08-24T23:46:03.000Z (3 months ago)
• Last Synced: 2024-08-25T19:34:42.301Z (3 months ago)
• Topics: api, back, expressjs, fasty-task, mongodb, nodejs, schedule, school, task-manager
• Language: JavaScript
• Homepage:
• Size: 4.87 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  


  Fasty-Task Server

  


  






  

  



The backend for `fasty-task`, an app to manage your scholar life. This backend only deploys an `API`, you will need to connect it to a `MongoDB` database using environment vars and use a compatible client _(see my [official web one](https://github.com/IsmaCortGtz/))_.

> [!CAUTION]

> The current version is in dev and can break some features.

### Table of Content

- [Documentation](#documentation-)

- [Requirements](#requirements-)

- [Run Locally](#run-locally-%EF%B8%8F)

- [License](#license-)

## Documentation 📕

You can see the documentation [here](./docs/README.md).

## Requirements 📋

`fasty-task-server` need the following to run:

- [Node.js](https://nodejs.org/) v18+ _(you can use [nvm](https://github.com/nvm-sh/nvm))_.

- [npm](https://www.npmjs.com/package/npm) _(normally included with node.js)_.

- MondoDB _(I recomend [MongoDB Atlas](https://www.mongodb.com/atlas/))_.

## Run Locally 🛠️

1. Clone the project

```bash

  git clone https://github.com/IsmaCortGtz/fasty-task-server.git

```

2. Go to the project directory

```bash

  cd fasty-task-server

```

3. Install dependencies

```bash

  npm install

```

4. Config `.env` file using this [guide](./docs/Environment%20Vars.md).

5. Start the dev server

```bash

  npm run dev

```

## License 🚨

This proyect is under the [**GPL v3**](https://www.gnu.org/licenses/gpl-3.0) license.

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)