nabeelnoor / feednext-nestjs Goto Github PK

feednext.io is an open source social media platform of the Feednext organization, founded by Software Engineer Onur Ozkan. The main purpose of the project is to inform people around the world about any physical or a virtual object from a single central source. Like a phone model, TV, Computer components or a Song even. I believe by doing that with the best way, this platform will turn into a central system of information distribution about product reviewing around the world.

• Installation
  • API
    • Import DB Dump
  • FRONTEND
• API Documentation
• Contributing
• Issue Tracking
• Privacy Policy
• Terms & Conditions

After you have forked and cloned this repository to your machine, cd into project folder and then create .env files from .env.example ones with following command:

cp .env.example .env && cp ./server/.env.example ./server/.env

Once .env files are created successfully, now you can run the api on your local by running following command:

make dev

With the command above, api will start running on http://localhost

The way of Docker (Linux containers) works on non-linux machines are pretty messy. With feednext, we have whole project folder passed into linux containers synchronously which works crystal clear on Linux machines. But, on non-linux machines it enforces your machine's drive pretty hard. For non-linux users, we have an alternative development way, instead of passing project folder, we will only use mongo and redis as containers and then will start api manually below the server directory.

Start mongo and redis containers:

make dev2

cd into server directory, and update the following values in .env file:

DB_HOST=localhost:27017
REDIS_HOST=localhost

Install dependencies:

npm ci

Run API:

npm run start:dev

Right after the command above, api will start running on http://localhost:3000

In the project root, run the following command to import/restore db dumps:

make import_db_dumps

In development mode, you can not create user accounts because of the sign-up mechanism of Feednext. Instead of creating accounts, you can sign in with already created demo accounts. The account credentials are as in the following table:

cd into client directory and then:

Install dependencies:

npm ci

Run Frontend:

npm run start:dev

If you follow the Osx & Windows way for running API, then apply following changes in config/constants.ts:

'http://localhost/api' TO 'http://localhost:3000/api'
'http://localhost' TO 'http://localhost:4001'

• Nginx
• NodeJS
• Typescript
• Mongodb
• Redis
• Docker
• Websocket protocol via socket.io
• Sentry

• NestJS
• JWT
• Typeorm
• PM2

• NextJS
• Ant Design UI Library
• Redux

API documentation is automatically generated by Swagger on development mode at /api endpoint.

See hosted documentation here

Technically, feednext.io is performance oriented application which is developed with Software Patterns & Design Principles using modern technologies all around it. PRs are welcome as long as they are fits in the principles, structure of the feednext.io.

Please do not directly PR to 'master' branch, instead go for 'dev' branch.

• If you have changed things below the server or client directories, commit messages must have [server] or [client] prefix.
• Commit messages should never include emojies
• Commit messages must be imperative like "Add stuff" not "Added stuff"

• Do not break the eslint rules.