blog-list-app

I am building a blog list application using MERN stack, that allows users to save interesting blogs they have stumbled across on the internet so that they could come back later and visit the blogs. For each blog, fields like URL, Title, Author and num of likes are stored.

How to run ?

• clone the repo using: git clone https://github.com/Vinayaka2k/blog-list-app.git
• Create a file .env in the root (folder that contains package.json)
• Add the following Env variables :
  MONGODB_URI = <your mongodb URI specifying a database>
TEST_MONGODB_URI = <your mongodb URI for the test database>
PORT = 3001
SECRET = <any string that can be used by jwt as the secret>
• install the dependencies listed below using: npm install <package-name>
• For development dependency, use: npm install <package-name> --save-dev
• Run the command for Development Environment: npm run dev
• Run the command for testing Environment: npm run test or simply npm test

Exposed Endpoints

There are currently three restful endpoints exposed for public consumption. You can read more about them here.

What has been completed till now ?

• APIs for CRUD operations on a Blog
• API for User Login : Token generation using jwt : Password Hashing using bcrypt
• API for CRUD operations on a User
• Created Schema for User and Blog
• Every user document has a reference to list of blogs created by him
• Every blog has the reference to the user who has created that blog
• Unit and API Testing for few APIs of User and Blog using jest and supertest
• Middlewares to handle exceptions thrown and handle invalid endpoints

Which features are currently being developed ?

• Currently developing the login functionality
• Also working on Token Authentication using jwt

TODO :

• Start with the front end for the appliaction with React
• Test Frontend with Jest
• After completing the whole stack, End to End testing using Cypress
• After making sure the app works locally, deploy frontend and backend independently to Vercel
• Make sure that the deployed app works by Testing
• Any other new feature that is suggested by the community !

Dependencies

• cors
• dotenv
• express
• mongoose
• nodemon (dev-dependency)
• jest (dev-dependency)
• cross-env (dev-dependency)
• supertest (dev-dependency)
• express-async-errors
• bcrypt
• mongoose-unique-validator
• jsonwebtoken

Want to contribute? Would be more than happy to review and merge your changes... Please raise a PR !!