/TechDegree-Project-9

A REST API using Express. The API provides a way for users to administer a school database containing information about courses: users can interact with the database by retrieving a list of courses, as well as adding, updating and deleting courses in the database. Technologies include REST API design, Node.js, and Express to create API routes, along with the Sequelize ORM for data modeling, validation, and persistence. Postman was used to test the application.

Primary LanguageJavaScript

treehouse logo

REST API Project

project preview

Overview of the Provided Project Files

The following files are supplied for the user:

  • The seed folder contains a starting set of data for your database in the form of a JSON file (data.json) and a collection of files (context.js, database.js, and index.js) that can be used to create your app's database and populate it with data (we'll explain how to do that below).
  • The package.json file (and the associated package-lock.json file) contain the project's npm configuration, which includes the project's dependencies.
  • The RESTAPI.postman_collection.json file is a collection of Postman requests that you can use to test and explore the REST API.

Getting Started

To get up and running with this project, run the following commands from the root of the folder that contains this README file.

First, install the project's dependencies using npm.

npm install

Second, seed the SQLite database.

npm run seed

And lastly, start the application.

npm start

To test the Express server, browse to the URL

http://localhost:5000/.