Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 3 KB

README.md

File metadata and controls

78 lines (52 loc) · 3 KB

Women Coders Network (WCN)

Welcome to the official repository for WCN, an organization dedicated to supporting and promoting women in technology through networking, resources, and community building.

Project Overview

This Next.js application serves as the central platform for WCN, featuring a Landing page, a Join Us page, a Join Our Discord page, and a Partnering Communities page. Built with TypeScript, ESLint, and Tailwind CSS, it aims to provide a welcoming and informative experience for all visitors.

Issues

If you would like to report a bug or suggest a feature, please create an Issue here and assign the correct Issue Type: Bug, Feature, Task. We will review the features at our weekly meeting and prioritize the backlog.

Project Board

To see our current list of issues, you may reference the project board here: https://github.com/orgs/womencodersnet/projects/1

Getting Started

Prerequisites

  • Node.js (v14.0 or higher recommended)
  • npm@10.6.0

Installation

  1. Clone the repository:

    git clone https://github.com/womencodersnet/wcn-website.git
cd wcn-website

  2. Install dependencies:

    npm install

  3. Start Development Server:

    npm run dev

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

Technologies Used

Contributing

We welcome contributions from everyone!

You can find all of our open issues, in progress issues, and completed issues here on our project board

If you would like to contribute to the WCN project, please reach out to @sunsplat on GitHub or @msesun on Discord to get added to the website team!

Please follow these steps for contributing:

  1. Clone the repository: git clone https://github.com/womencodersnet/wcn-website.git
  2. Switch to the dev branch: git checkout dev
  3. Create a new branch. We have 3 different types of changes: feature, bugfix, task
    • For features, your branch name should follow the following pattern: feature-<ISSUE_NUMBER>- ie: feature-18-header-component
    • For bugfix: bugfix-<ISSUE_NUMBER>-<ONE OR TWO WORD DESCRIPTION> ie: bugfix-18-missing-icon
    • For task: task-<ISSUE_NUMBER>-<ONE OR TWO WORD DESCRIPTION> ie: task-18-update-readme
  4. Make your changes and commit them.
    • Commit messages should start with your change type and issue # so that we can easily search and track the changes
    • ie: git commit -m "TASK-18 updating readme to include list of technologies"
  5. Push your changes to your branch.
  6. Open a pull request to the dev branch.