Global Code Queens Open Source Project

Table of Contents

• Introduction
• Challenge
• Design
• Features
• Installation
• Contributing

Introduction

This is an open source project developed as part of the Open Source Project initiative by the FrontEnd Queens

Challenge

The challenge is to build out a multi-page website and get it looking as close to the design as possible.Your users should be able to:

• See the correct content for each team member on the About page when the + icon is clicked
• Receive an error message when the contact form is submitted if:
  • The Name, Email Address or Message fields are empty should show "This field is required"
  • The Email Address is not formatted correctly should show "Please use a valid email address"
• View the optimal layout for the interface depending on their device's screen size
• See hover and focus states for all interactive elements on the page

Design

The challenge is part of Frontend Mentor premium version, hence we are not adding a link of the Design file here.

Features

• Feature 1: This Project includes 4 fully responsive web page create with React
• Feature 2: It includes Hash Router for the implementation of the routing system
• Feature 3: The Typography and Button across this project uses a common styling system
• Feature 4: As part of the Innovation of the challenge, this website has an explicit error page for invalid routes.
• Feature 5: The project uses css modules for the implementation of the stylesheet
• Feature 6: The project implements a Form with Client side validation.
• Feature 7: The project is deployed using Github Pages and Github Actions. Deployed URL
• Feature 8: This project uses npm as its package manager.

Installation

To install and set up this project, follow these steps:

Prerequisites

• The Project is build with React v18
• The Project is handled with git and Github. Please follow the procedure linked here

Clone the Repository

git clone git@github.com:poulami-saha/Global-Code-Queens-MyTeam-Website.git
cd Global-Code-Queens-MyTeam-Website

Install Dependencies

npm install

Running the Application

npm start

Repository Author & Maintainers

1. Rika Williams
2. Manami W
3. Eunice Y
4. Feven Seyfu
5. Joan Wolkerstorfer
6. Kezia Baidoo
7. Sehaj Wadhwa
8. Uzma Khan
9. Poulami Saha

Contributing

We welcome contributions! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

For Github Related queries please follow the procedure linked here