abhi5658/blogging_application

A react based minimal blogging application with features - list / read / create blog(s)

blogging_application

This repo houses backend and frontend for blogging application

Backend APIs

Blog service

1. GET /blogs - Retrieves recently created blogs
2. POST /blog - Creates a new blog
3. GET /blogs/:id - Retrieves blog by id

Server Notes

• The server is running with nodemon which will automatically restart for you when you modify and save a file.

• The database used is SQLite, which will store data in a file local to your repository called database.sqlite3. The ORM Sequelize is on top of it.

• The BACKEND server is running on port 3001.

Understanding project structure

• src/routes contains all the routes or path of the application
• src/controllers contains all the controllers attached to paths are places in
• src/services contains independent functions to perform different actions on DB or get data from DB
• tests/unit contains unit tests for all services
• tests/integration cantains all the controller level or API integration tests

Testing the backend 🎮

• Go to backend directory

cd backend/

• Run tests ✅

npm run test

• Setup and start the backend application ▶️

npm run seed
npm run start

• Open Postman
  • Import postman_collection.json from this repo to test out the post analytics service
  • Import blogging.postman_collection.json from this repo to test out the mock stock trading service
  • Run all the request to test out all applications

Frontend

Frontend routes

1. / - Home page og blogger website
2. /blogs - Alternate to home page
3. /blogs/:id - Open full blog
4. /create - Create a new blog

Understanding frontend project structure

• src/components contains all the UI components
• src/services contains independent functions to perform different backend API calls

Testing the frontend 🎮

• Go to backend directory

cd frontend/

• Start the frontend application ▶️

npm run start

• Frontend is hosted at http://localhost:3000/

Functionalities

• List all the blogs on homepage
• Click on specific blog to view full blog
• "Create a new blog" button to create a new blog