README.md

NetNest

Table of Contents

1. About The Project
   • Built With
2. Deployment
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
   • Local Run
   • Docker Run
5. Design Document
6. Contributing
7. License
8. Contact

About The Project

A social media backend application supported by JWT Authentication, with features to perform requests to follow, unfollow, CRUD operations with posts, likes, comments etc. Built with Typescript and Node.js, with PostgreSQL database and Prisma ORM.

Built With

• 
• 
• 
• 
• 
• 

Getting Started

Prerequisites

• Install Node.js and npm
• Install PostgreSQL

Setup

• Clone the repo

  git clone https://github.com/rudrankbasant/NetNest

• Change into the directory

  cd NetNest

• Environment Variables

  touch .env

  To run this project successfully you'll need to create a .env file and store your PostgreSQL there like .env.sample.

Usage

Local Run

Install NPM packages

npm i

Build the app

npm run build

Start the app

npm start

Now, may access the app on http://localhost:PORT

PORT: You must have already specified in the .env file (8000 by default)

Docker Run

docker-compose up --build -d

Now, may access the app on http://localhost:80

Contributing

Contributions 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 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 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Developer

Rudrank Basant