tomalcock / nc-news Goto Github PK

This is my first every full-stack application. It has a mobile first UX design and allows uses to scroll through news articles. A user may wish to:

• View all articles
• View topics available
• Search for topics (although there are currently only 3 available in the production database at the moment)
• Log in as a user already in the database (no authentication feature currently). This then displays on all screens
• Sign out as the user
• Vote on an article (which sends a patch request to the API)
• Post a comment (which sends a post request to the API)
• Delete a comment (which sends a delete request to the API)

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

(back to top)

(back to top)

• npm

  npm install npm@latest -g

1. Clone the repo

   git clone https://github.com/tomalcock/nc-news.git

2. Install NPM packages

   npm install

3. To view current app locally

   npm run dev

(back to top)

(back to top)

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)

Tom Lacy-Alcock - [email protected]

Project Link: https://github.com/tomalcock/nc-news.git

(back to top)

• Northcoders

(back to top)