Live version: https://hc-nc-news-api.onrender.com/api
This is an API designed to query an SQL database, containing information about news articles, via multiple endpoints using the CRUD, REST and MVC methodoligies. This is built using Node JS and Postgres (PSQL), the first iteration of the app used Javascript and express but has now been migrated to use Typescript and fastify. Node pg is used to query the PSQL database.
To clone this repo you must have git installed on your system. Then navigate to the desired location you want the repo to be contained in and run the following command in your terminal
git clone https://github.com/HarCass/nc-news-api
You may be prompted for your github details.
You can then make your may into the repo by running the following command in the terminal
cd nc-news-api
Once the repo is cloned and you have navigated inside of it, you can install the needed dependencies for the application. To do so you must have at least Node version 18.13.0 installed with pnpm installed (you can use npm but I cannot guarantee the app will work correctly) and run the following command in the terminal
pnpm install
Now that dependencies are installed you can setup your databases. To do so you must have at least Postgres version 12.14 installed and run the following in your terminal
pnpm run setup-dbs
This will create a development and test database named nc_news and nc_news_test respectfully.
If you wish to change the names of the databases you can do so by editing the setup.sql file in the db folder.
To successfully connect to the databases locally you must first setup your environment variables.
To do so, please create two files in the root directory .env.test and .env.development. Check the .env-example file to see what the content should look like.
The database names in the files should look something like this
- For the development file
PGDATABASE=database_name_here - For the test file
PGDATABASE=database_name_here_test
The username and password comes from your local PSQL settings.
Once you have setup the .env files you can run the following command in your terminal to seed your development database
pnpm run seed
This will seed the development database, you can then view it via Postgres in your terminal or run
pnpm run build
pnpm start
this will start the application so you can interact with the database via the API (You can make requests to it with an application such as postman or view the GET endpoints in your browser, the application runs on localhost PORT 9090 by default).
If you wish to also seed the test database you can do so by running the following command in your terminal
pnpm test app
This will run some tests for the application to make sure it is working correctly and simultaneously seed the test databse.
Make a GET request to the endpoint /api to get a list of available endpoints.
See error-handling.md.