https://github.com/omkargade04/community-backend
This application is a BACKEND PROJECT built in Typescript which provides users with a RESTful Community Creating API able to perform CRUD Operations and stores data using PostgreSQL Database with features such as user Authentication and Authorization.
https://github.com/omkargade04/community-backend
docker expressjs nodejs postgresql typescript
Last synced: 4 months ago
JSON representation
This application is a BACKEND PROJECT built in Typescript which provides users with a RESTful Community Creating API able to perform CRUD Operations and stores data using PostgreSQL Database with features such as user Authentication and Authorization.
- Host: GitHub
- URL: https://github.com/omkargade04/community-backend
- Owner: omkargade04
- Created: 2024-03-23T00:15:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-26T18:09:38.000Z (about 2 years ago)
- Last Synced: 2025-02-23T00:14:43.654Z (over 1 year ago)
- Topics: docker, expressjs, nodejs, postgresql, typescript
- Language: TypeScript
- Homepage: https://community-backend-5z55.onrender.com
- Size: 80.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
This application is a BACKEND PROJECT which provides users with a RESTful Community Creating API able to perform CRUD Operations and stores data using PostgreSQL Database with features such as user Authentication and Authorization.
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run dev
```
## Features of the Application
- Each user, can create a community and (automatically) gets assigned the Community Admin role. They can add other users to the community who get assigned the Community Member role.
- Authentication
- User can signup and login using valid credentials.
- Community
- User can see all communities and create a new community.
- Moderation
- User can see all community members and add a user as member.
- User can remove a memberfrom community.
-
## Flow of Application
- First you need to cd into the server directory and run "npm install" to install the node_modules.
- Secondly you need to integrate your database(PostgreSQL) with the application
create a .env and add your database credentials accordingly
- Run the following command line : "npm run dev" to get started with the application
- To test the API endpoints, open any API Tester application such as Postman or Thunder Client.
- Make sure that you login with a user and give its Authentication Bearer Token in the Token field.
- Test the APIs and you are all set to go.
- ## API Documentation
- I made an api documentation for the project. The link is below.
- Read the documentation and test the routes
- https://documenter.getpostman.com/view/27201705/2sA35Bd4zc