Socioboard Api's is created with Node.js, Express, MongoDB and Sequelize ORM. Socioboard Api are classified to four micro services. They are namely
User Services - Responsible for Managing User, Team, Payment, App Insights and Admin functionalities.
Publish Services – Responsible for Managing Media Uploads, Scheduling, Publish now and Report functionalities through respective Social Network Api's.
Feed Services – Responsible for fetching Feeds from Social network API's and various popular trending networks such as Pixabay, Imgur, Daily motion, Flickr and so on.
Notification Services – Responsible for sending emails and notify the user activities through Socket.io
NODE ^14 OR LATEST
NPM ^7 OR LATEST
NODEMON ^2 OR LATEST
MIN 5 FREE PORTS
PM2 – FOR AUTOMATION & EASY MANAGEMENT
Mongo Database
MySQL Database
5 free ports
1. Requirement check.
a. Node js ^14 (14 or more)
b. Npm version ^6 (6 or more)
c. PM2 version (latest)
d. Nodemon Latest version (2 or more)
e. MySQL Creds
f. Mongo Database Creds
2. Setting up server environment.
3. Installing Node Packages in all folders
4. Setting up MySQL Database
5. Updating the config files (minimum required should fill with proper details)
6. Starting the micro-services (User, Feeds, Publish, Update)
7. Checking the Error Logs
a. To check node installed or not, use `node -v` command in Terminal
It should give version number. like: v14.15.2
-- If not Please visit the site(https://nodejs.org/) and download the latest stable version.
b. To check npm version, use `npm -v`.
It should give version number. like: 7.15.1
-- It won't work if there's no node version (above one)
c. To check pm2 installed or not use `pm2 --version`
It should give version number. like: 5.1.0
-- If not Please visit the site(https://pm2.keymetrics.io/) and download the latest stable version.
or
use `npm install pm2 -g` command to install the latest stable version.
d. To check nodemon version, use `nodemon -v`
It should give version number. like: 2.0.13
-- If not please use `npm i nodemon -g` to install latest one.
e. MySQL & Mongo creds are compulsory, so Please follow proper way to install it in local system or use cloud creds.
For windows environment
set NODE_ENV=development
For linux || mac environment
export NODE_ENV=development
cd ./socioboard-api/User & npm install & cd ../Feeds & npm install & cd ../Common & npm install & cd ../Update & npm install & cd ../Publish & npm install & cd ../Notification & npm install
A. Setting the config file for Database connections.
Open the config.json file located at `socioboard-api\Common\Sequelize-cli\config\config.json`
And Update The below mentioned keys in `development` key
"username": "<< DB USER NAME >>",
"database": "<< Database name >>",
"password": "<< password >>",
"host": "127.0.0.1",
and save the file.
B. Creating Tables.
run `set NODE_ENV=development & npx sequelize-cli db:migrate` command in `socioboard-api\Common\Sequelize-cli`
or Run this command in root directory.
`cd socioboard-api\Common\Sequelize-cli & npx sequelize-cli db:migrate`
It should list all the tables it creating without any errors.
C. Setting up migrations.
As you're in the Sequelize-cli folder you can simply run `npx sequelize-cli db:seed --seed 20210303111816-initialize_application_informations.cjs` command.
It will add data into single table.
Most important is we need to setup mongo and mysql objects values properly in all config folders.
Ex: in `User` folder `config/development.json` file and fill the << Description >> places with correct files.
- Note: In all folders update the configuration files properly.Make sure you're in Root directory.
For Generating swagger file in User micro service you need to go to User folder Then run `npm run swagger` and it should say success.
cd ./socioboard-api/User & npm run swagger & cd ../Feeds & npm run swagger & cd ../Publish & npm run swagger & cd ../Notification & npm run swagger & cd ../Update & npm run swaggerFor Linux
cd ./socioboard-api/User && npm run swagger && cd ../Feeds && npm run swagger && cd ../Publish && npm run swagger && cd ../Notification && npm run swagger && cd ../Update && npm run swagger
+ We should do this in rest 3 micro services as well.Make sure you're in Root directory.
For starting User micro service you need to go to User folder Then run `nodemon user.server.js` and it should start in port 3000(which is configured in `development.json` file)
+ We should do this in rest 3 micro services as well.Note: If you facing any issue, in that same folder you need to go to resources/Log/ResponseLog folder and check the proper log file to fix it.
Your Terminal should be in Root Directory. then run the below command.
set NODE_ENV=development & cd ./socioboard-api/User & pm2 start ./socioboard-api/User/user.server.js & cd ../Feeds & pm2 start ./socioboard-api/Feeds/feeds.server.js & cd ../Publish & pm2 start ./socioboard-api/Publish/publish.server.js & cd ../Notification & pm2 start ./socioboard-api/Notification/notify.server.js & cd ../Update & pm2 start ./socioboard-api/Update/update.server.js & pm2 status
It will Give you all your services status in a table.