https://github.com/notadson/volunteerhub-api

It's an API for connecting the project's database with the client side interface, and performing validations.
https://github.com/notadson/volunteerhub-api

express express-js expressjs javascript jsonwebtoken jwt jwt-auth jwt-authentication jwt-token

Last synced: about 2 months ago
JSON representation

It's an API for connecting the project's database with the client side interface, and performing validations.

• Host: GitHub
• URL: https://github.com/notadson/volunteerhub-api
• Owner: NotAdson
• License: mit
• Created: 2024-05-29T20:38:54.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-27T14:57:33.000Z (almost 2 years ago)
• Last Synced: 2025-03-27T16:43:50.343Z (about 1 year ago)
• Topics: express, express-js, expressjs, javascript, jsonwebtoken, jwt, jwt-auth, jwt-authentication, jwt-token
• Language: JavaScript
• Homepage: https://volunteerhub-api.onrender.com
• Size: 67.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Volunteer Hub - API

![License](https://img.shields.io/badge/License-MIT-blue.svg)

It's an application programming interface for connecting the project's database with the client side interface, and performing validations.

## Summary

- [How to set it up?](#1-how-to-set-it-up)

    - [Installing](#11-installing)

    - [Starting](#12-starting)

- [Technologies used](#2-technologies-used)

## 1. How to set it up?

To set up the project, you first need to have installed the following technologies on your machine:

- [Node.js](https://github.com/nodejs/node)

- [Node Package Manager](https://github.com/npm/documentation)

### 1.1 Installing

To install the project, clone this repository, and run the following command in the folder called `server` to install the project's dependencies:

`npm install`

### 1.2 Starting

First, you need to create an environment using the `server` folder as the root folder with the following variables set:

- **TOKEN:** a token to make the user authentication.

- **ADDRESS:** a link to the database.

To start the project, you just need to run the following command in the `server` folder:

`npm run start`

## 2 Technologies used

This project uses the following technologies:

- **Express.js** 

- **Javascript**

- **[NPM](https://github.com/npm/documentation)**

- **[Node.js](https://github.com/nodejs/node)**

- **JWT**

- **Sequelize**

- **Postegresql**