Welcome to the DevDogs Open-Source Website!

We’re excited to have you here! If you’re interested in contributing to our project, please request to join the web development team here and join our Discord server.

This project is built using Next.js and was bootstrapped with create-next-app.

Technologies We Use

• Next.js / Node.js
• React.js
• Custom CSS
• Firebase
• Tailwind CSS

Contributor Requirements

To contribute to this website, you should have a basic understanding of JavaScript, HTML, CSS, and React.js.

Getting Started

1. Join the Team: Request to join the current year's Website Contributor team on our GitHub Organization. 2024-2025
2. Review Issues: Check the Issues tab to see what work needs to be done. If you have recommendations, post them in our web-development Discord channel!
3. Fork the Repository: Create a fork of this repository to work on your own copy of the code. Assign yourself an issue to work on.
4. Clone the Repository: Use Git or GitHub Desktop to clone your forked repository to your local machine.
5. Set Up the Environment: Run npm install to install the latest packages and dependencies.
6. Work on the Issue: Complete the tasks associated with your assigned issue.
7. Push Changes: Push your local changes to your forked GitHub repository.
8. Create a Pull Request: Once your work is complete, submit a pull request (PR) to the original repository. Be sure to document your changes thoroughly and include any relevant screenshots.

Important: Always sync your forked repository with the original before starting any new coding session, and pull the latest changes to your local machine.

Code Quality

We maintain code quality using ESLint and Prettier. Please ensure your code follows our guidelines by running the following commands before submitting your pull request:

• To automatically fix issues: npx eslint --fix src
• To format your code: npx prettier --write src

Important Notes

• Design Consistency: Refer to our Figma file for consistent styling across the website.
• Resources: Images and key links mentioned in the Figma can be found in our Google Drive Website Assets folder.
• Branding Guidelines: DevDogs' logos, color palettes, fonts, and other key components of the DevDogs brand and their acceptable use can be found here.
• Colors: Use the color.css file for color references throughout the website.

How to Run Locally

To run the development server on your local machine, navigate to your project folder in the terminal and use one of the following commands:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More on Next.js

Here are some resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.
• Learn Tailwind CSS - documentation for Tailwind CSS.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!