No longer maintained
## What is this all About ?
feednext.io is an open source social media platform of the Feednext organization, founded by Software Engineer [Onur Ozkan](https://github.com/ozkanonur). 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](https://github.com/feednext/feednext#installation)
- [API](https://github.com/feednext/feednext#api)
- [Import DB Dump](https://github.com/feednext/feednext#import-db-dump)
- [FRONTEND](https://github.com/feednext/feednext#frontend)
- [API Documentation](https://github.com/feednext/feednext#api-documentation)
- [Contributing](https://github.com/feednext/feednext#contributing)
- [Issue Tracking](https://github.com/feednext/feednext/issues)
- [Privacy Policy](https://github.com/feednext/feednext/blob/master/PRIVACY-POLICY.md)
- [Terms & Conditions](https://github.com/feednext/feednext/blob/master/TERMS-CONDITIONS.md)
## Installation #### Requirements | Technology | Version | | ------ | ------ | | Docker | * | | Docker Compose | * | | Make | * | | Node | LTS | ### API 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: ```bash 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: ```bash make dev ``` With the command above, api will start running on http://localhost #### WARNING (For Osx & Windows Users) 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: ```bash make dev2 ``` cd into server directory, and update the following values in .env file: ``` DB_HOST=localhost:27017 REDIS_HOST=localhost ``` Install dependencies: ```bash npm ci ``` Run API: ```bash npm run start:dev ``` Right after the command above, api will start running on http://localhost:3000 #### Import DB Dump In the project root, run the following command to import/restore db dumps: ```bash 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:
| Username | Email | Password | Role | | ------ | ------ | ------ | ------ | | admin | admin@demo.com | admin123 | 5 | | jacky_eirl | jacky_eirl@demo.com | demo123 | 0 | | jens.auhrk | jens.auhrk@demo.com | demo123 | 0 | | teo.alpha | teo.alpha@demo.com | demo123 | 0 | | saul.kuvarsk | saul.kuvarsk@demo.com | demo123 | 0 | | onur.ozkan | onur.ozkan@demo.com | demo123 | 0 | ### FRONTEND cd into client directory and then: Install dependencies: ```bash npm ci ``` Run Frontend: ```bash 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' ```## Tech Stack #### Core - [Nginx](https://www.nginx.com) - [NodeJS](https://nodejs.org/en) - [Typescript](https://www.typescriptlang.org) - [Mongodb](https://www.mongodb.com) - [Redis](https://redis.io) - [Docker](https://www.docker.com/) - Websocket protocol via [socket.io](https://socket.io) - [Sentry](https://sentry.io) #### API - [NestJS](https://nestjs.com) - [JWT](https://jwt.io) - [Typeorm](https://typeorm.io) - [PM2](https://pm2.keymetrics.io) #### Web Frontend - [NextJS](https://nextjs.org) - [Ant Design](https://ant.design) UI Library - [Redux](https://redux.js.org)
## API Documentation API documentation is automatically generated by Swagger on development mode at /api endpoint. See hosted documentation [here](https://documenter.getpostman.com/view/4176747/SzYW3faf)
## Contributing 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. ### Styleguilde #### Commit Messages - 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" #### Coding - Do not break the eslint rules.