The goal of News Stand is to provide users a clean, all-in-one place to find, consume, and comment on the news. News sites are fragmented and RSS feeds don’t allow users to comment, so we want to combine the two.
Our project is built using the MERN stack.
- Katherine Manning
- Patrick Miner
- Ayush Kumar
- Danny Welstad
From the command line, run the following commands:
Clone:
git clone https://github.com/news-stand/news_stand
Navigate Into Repo:
cd news_stand
Install Dependencies:
npm install
Start:
npm run start:dev
Note: This starts the Webpack bundler and Babel transpiler, which run in parallel with nodemon to run your server. You only need one open "running" terminal, rather than three. All three will watch for changes, so you don't need to re-run or re-start any of the processes.
- node 8.4.0
- express
- body-parser
- mongodb
- mongoose
- react
- react-dom
- react-router
From within the root directory:
npm install
This project uses the dotenv module to read and configure environment variables from a .env file. The .env is included in .gitignore and is where you should store your API keys.
The .env reads bash commands, so set environment variables like you would in the terminal.
# for example:
NEWS_KEY=yourKeyHere
You then can access the environment variables in your JavaScript files.
// for example:
search = `https://newsapi.org/v2/everything?q=art&sources=bbc-news&sortBy=popularity&apiKey=${process.env.NEWS_KEY}`
This project uses information from NewsAPI. For development, you'll need an API key that you set in your environment variables.
Endpoints:
- /v2/everything: For articles searches
- /v2/sources: For an up-to-date list of possible sources to query
View the project roadmap here
See CONTRIBUTING.md for contribution guidelines.