blogApp

A awesome blog application to share yourself with the world!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

blogApp is a web application that people can post, view, like and comment blogs within the blogApp community.

blogApp is initially created as a project assignment from the course full stack open.

I further modified the frontend view and add some extra functionalities to the backend service.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow these steps to run the application in your host machine or inside Docker containers.

Prerequisites

To run the application in your host machine, you need to have npm set up. Otherwise, you can choose to use Docker,

• npm

  Recommend using nvm for Node version management

  nvm

• Docker

  Use docker to easily build, and run the application

  Docker

Installation

• Run in the host machine

1. Clone the repo

   git clone https://github.com/yingtu35/blogApp.git

2. Install NPM packages on both backend and frontend folders

   npm install

3. Create a .env file in the backend folder for mongodb url and jwt secret

   TEST_MONGODB_URL=paste your testing mongo url here
   MONGODB_URL=paste your mongodb url here
   SECRET=paste your jwt secret here

4. Create a .env file in the frontend folder for connection to the backend service

   REACT_APP_BACKEND_URL=http://localhost:portForYourBackend

5. Start both server in the development mode
   • backend

     npm run start:test

   • frontend

     npm start

• Run in Docker

1. Clone the repo

   git clone https://github.com/yingtu35/blogApp.git

2. In blogApp directory, run the container in either development mode or production mode
   • development

     docker compose -f docker-compose.dev.yml up

   • production

     docker compose up

(back to top)

Usage

Enjoy the short 2-min demo to see how BlogApp works.

Demo

(back to top)

Roadmap

• Add sign up UI
• Search bar for blogs
• Search bar for users
• Better view for comments
• Deploy to a remote server

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @YingTu1685990 - yingtu35@gmail.com

Project Link: https://github.com/yingtu35/blogApp

(back to top)

Acknowledgments

• Full Stack open

(back to top)