ECG Robotics Website

Welcome to the official ECG Robotics website repository! Here you can find all of the code for the ECG Robotics website.

View Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started With Contributing
   • Prerequisites
   • Installation
3. Roadmap
4. License
5. Contact
6. Acknowledgments

About The Project

This website is the overhaul of the old ECG Robotics website, which was outdated and made using Wordpress. This new version offers more customization options and allows students to gain skills in using real-world web development tools such as HTML/CSS and React.js.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started with Contributing

To get a local copy up and running, follow these simple steps.

Prerequisites

To contribute to this project, you need four essential tools:

• A GitHub account - To fork the repository and submit changes
• npm – To manage project dependencies
• Git – To push and pull changes
• A code editor – To write and edit code (Visual Studio Code is recommended)

Follow these steps to ensure you have everything set up:

1. Create a GitHub Account

If you don’t already have a GitHub account, create one by visiting GitHub and signing up.
You'll need this to fork the repository, submit pull requests, and collaborate on the project.

2. Install npm

First, check if npm is already installed by running:

npm -v

If you see a version number, you're good to go! Otherwise, install npm by following the instructions on the official npm repository.

3. Install Git

Check if Git is installed by running:

git -v

If you see a version number, you’re good to go! Otherwise, install Git by visiting the Git website and following the installation instructions for your operating system.

4. Install a Code Editor (Recommended: Visual Studio Code)

While you can technically use any text editor, Visual Studio Code (VS Code) is highly recommended because of its powerful features like syntax highlighting, autocompletion, and an integrated terminal.

Check if VS Code is installed by running:

code -v

If you see a version number, you're good to go! Otherwise, to install VS Code, perform the following steps:

1. Go to the VS Code download page.
2. Select your operating system (Windows, macOS, or Linux).
3. Download and install it following the setup instructions.

Recommended VS Code Extensions

For the best experience, install these extensions:

• GitHub Copilot – An AI-powered coding assistant that helps write code faster. If you're a student, you can get GitHub Copilot for free through the GitHub Student Developer Pack.
• ES7+ React/Redux/React-Native snippets – Provides useful shortcuts for React development, like rfce for function components and useState snippets.

---

Once you have npm, Git, and VS Code installed, you're ready to clone the repository and start contributing!

Installation

1. Fork the repository to create your own copy that you can make changes on. If you'd like to make changes to the website, you'll eventually make a pull request to request for your changes to be put on the website.

2. Open your terminal and navigate to the folder that you want your project to be hosted in by running:

   cd <folder-path>

3. Clone your forked repository to your local machine by running the following command in your terminal (replace <your-username> with your GitHub username):

   git clone https://github.com/<your-username>/<repository-name>.git

   This will download the project files to your computer.

4. Navigate into the project folder:

   cd <repository-name>

5. Install dependencies: You'll need to install all required npm packages before running the project. Run:

   npm install

   This will download and set up all the necessary dependencies.

6. Start the development server:

   npm run dev

   This will start the Vite development server, and you should see a local URL (e.g., http://localhost:5173/) where the website is running. Open this link in your browser to preview your changes live.

7. Make your changes: Open the project folder in Visual Studio Code (VS Code) and start editing the files.

8. Commit and push your changes:

   • After making changes, stage them:

     git add .

   • Commit them with a message describing what you changed:

     git commit -m "Your commit message here"

   • Push your changes to your forked repository:

     git push origin main

9. Submit a pull request:

   • Go to your forked repository on GitHub.
   • Click on the "Contribute" button and select "Open Pull Request".
   • Describe your changes and submit the pull request.

Once your pull request is reviewed and approved, your changes will be merged into the main project!

Top contributors:

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Keval Shah - kevals2005@gmail.com

Project Link: https://github.com/kevalshah2005/ecgrobotics.org

(back to top)

Acknowledgments

• All the incredible ECG Robotics students, mentors, and parents. Without your work, this club wouldn't be possible!

(back to top)