Northcoders News API

For instructions, please head over to L2C NC News.

---

This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders

Welcome to the NC News API! 🎉 Hey there! 👋 Welcome to the NC News API, your very own backend service designed to mimic a real-world platform like Reddit. This project is all about giving you hands-on experience in building a backend that dishes out all the juicy data to the front end. Ready to dive in? Let’s get started!

🌐 Check It Out Online You can see the hosted version of our API in action right here: https://be-nc-news-ftvm.onrender.com/api

📚 What’s This All About? The NC News API is built to simulate a backend service similar to Reddit. It’s designed to serve data to the frontend architecture, providing endpoints for articles, comments, users, and more. Think of it as your playground for backend development.

🚀 Getting Started Ready to get your hands dirty? Follow these steps to get the project up and running on your local machine.

Clone the Repo

First things first, clone the repository to your local machine:

* bash
* Copy code
* git clone https://github.com/your-username/nc-news-api.git
* cd nc-news-api

Install Dependencies

Next, let’s install all the necessary dependencies. Make sure you’re in the project directory:

* bash
* Copy code
* npm install

Set Up Your Environment Variables

You'll need to create two .env files in the root of your project: .env.development and .env.test. These files should contain the following environment variables:

Seed Your Local Database

Before running the application, you’ll need to seed your local database with some data:

Run the Tests

Make sure everything is working as expected by running the test suite:


🛠️ Requirements
To ensure everything runs smoothly, make sure you have the following minimum versions installed:

Node.js: v14.x
Postgres: v12.x
And that’s it! You’re now ready to explore and extend the NC News API. Happy coding!

💡 Need Help? If you run into any issues or have any questions, feel free to open an issue or reach out. We’re here to help!

Thanks for checking out the NC News API. We hope you have a blast working with it. Now go build something awesome! 🚀