Thanks for your interest in contributing! Here are the steps to get started:
Prerequisites
- Git & GitHub account
- Node.js installed
- Code editor like VS Code
Setup
- Fork the repository
- Clone your forked repo
git clone https://github.com/cjstyles6/news-website.git - Install dependencies
npm install - Start development server
npm run dev
News API This project uses the NewsAPI to fetch news articles. You'll need to sign up for a free developer account to obtain an API key.
Add your API key to script.js file
Tailwind CSS This project uses Tailwind CSS for styling. The Tailwind directives are added in input.css.
To recompile Tailwind styles, run:
npm run build
This will generate the output.css stylesheet.
Making Changes
- Create a new branch
- Make code changes as needed
- Test changes locally before committing
- Commit changes with clear commit message
- Push changes to your fork
- Open a pull request to the upstream repository
Let me know if you have any questions!