Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 1.87 KB

README.md

File metadata and controls

20 lines (15 loc) · 1.87 KB

Blog API Project - Public Frontend

This project seeks to build out the features and functionality described in TOP's NodeJS Blog API project

Specifically, this repo contains the code to serve a React/React-router-dom project with Vite. This app is not a true SPA, due to the limited interactivity needed, I felt that making it a full SPA was a bit overkill for this project. The project's goals are to design/implement/interact with a REST API. I also made the choice to limit the scope of the project to one admin/author account, and not force readers to make an account to comment. I will tackle more robust user schemes/strategies in my upcoming projects.

Links to other the repos of this project

How to get a development instance of this project running locally

  1. First, follow the instructions in the backend repo's readme to get a development backend server running locally on localhost:3000.
  2. Clone this repo to your machine.
  3. cd into the folder created by cloning, and run npm install to install the dependencies.
  4. Then run npm run dev to start the development web server. Vite typically defaults to localhost:5173, but regardless, your specific port will be printed to the terminal
  5. Success! You have this app running. If you don't see any content, it's because there isn't any yet populated to the database for this app to fetch
  6. Spin up the authoring frontend to create and administer the content for this site by following the steps in the Authoring repo
  7. Feel free to create an issue on GitHub if you run into any issues.

Thanks for taking the time to explore my project!