Skip to content

Latest commit

 

History

History
239 lines (172 loc) · 8.28 KB

README.md

File metadata and controls

239 lines (172 loc) · 8.28 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Car API App

This is a single-page React app (frontend) that uses Express API (backend) to GET, POST, PUT or DELETE data(cars) to a JSON file. This project is a school project.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

(back to top)

Built With

  • React
  • Expressjs
  • Bootstrap

(back to top)

Getting Started

Prerequisites

N/A

Installation

  • Clone the repo

    git clone https://github.com/KaraboMolemane/car-api-app.git

  • Run Back end

    • Open the project in a terminal and install NPM packages 
      npm install
    • Once the installtion is done, you can start the backend by typing the following: 
      npm start
    • The back end runs on http://localhost:8080/
    • The project uses nodemon to automatically reload every time a change is made and saved.

  • Run Front end

    • Open another instance of the terminal on your project and navigate to the front end by typing 
       cd frontend
    • Install NPM packages for the front end 
       npm install
    • Once the installtion is done, you can start the frontend by typing the following: 
      npm start
    • The front end runs on http://localhost:3000/ and will automatically open on your default browser. if this does not happen, simply open http://localhost:3000/ on your preffered browser.
    • The project uses nodemon to automatically reload every time a change is made and saved.

(back to top)

Usage

Once the project is opened in your browser. You will be presented with the home screen with existing cars. On this screen you will be able to view, add, edit, and delete cars.

Logo
Logo

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Only allow link format for ULRs

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

N/A

(back to top)

Contact

Karabo Molemane - https://www.linkedin.com/in/karabo-molemane/

Project Link: https://github.com/KaraboMolemane/car-api-app

(back to top)

Acknowledgments

(back to top)