![Logo](/yingtu35/blogApp/raw/main/images/logo.png)
A awesome blog application to share yourself with the world!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
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.
Follow these steps to run the application in your host machine or inside Docker containers.
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
-
Docker
Use docker to easily build, and run the application
- Run in the host machine
- Clone the repo
git clone https://github.com/yingtu35/blogApp.git
- Install NPM packages on both backend and frontend folders
npm install
- 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
- Create a .env file in the frontend folder for connection to the backend service
REACT_APP_BACKEND_URL=http://localhost:portForYourBackend
- Start both server in the development mode
- backend
npm run start:test
- frontend
npm start
- backend
- Run in Docker
- Clone the repo
git clone https://github.com/yingtu35/blogApp.git
- 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
- development
Enjoy the short 2-min demo to see how BlogApp works.
- 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).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Your Name - @YingTu1685990 - yingtu35@gmail.com
Project Link: https://github.com/yingtu35/blogApp