WomenCodingCommunity / WomenCodingCommunity.github.io

https://womencodingcommunity.com
MIT License
8 stars 21 forks source link

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Issues][issues-shield]][issues-url] [![Stargazers][stars-shield]][stars-url]

Welcome to Women Coding Community :sparkles: :computer:

The Women Coding Community is a community dedicated to inspiring women to excel in their technology careers. Our events cover various topics around software engineering. If you're interested in joining the community as a member or volunteer please visit our website or join our slack TODO.

Check out Code of Conduct

About

TBD

Please, find more information on our website.

Contributing

This website acts as a project to help introduce people to the Open Source community, and allow transition from newcomers to contributors easier.

We welcome your contributions! πŸ’• To contribute to this repo, follow the contributing guidelines.

About our project

How to Run Project Locally

This content is created using GitHub Pages with Jekyll.

Prerequisites

Before you can use Jekyll to test a site, you must:

  1. Install Jekyll. Create a Jekyll site. For more information, see "Creating a GitHub Pages site with Jekyll." We recommend using Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler:

  2. Install Ruby. For more information, see Installing Ruby.

  3. Install Bundler. For more information, see Bundler

Build and run

Run Tests Locally

  cd tools 
  ls -lah
  python -m pip install --upgrade pip
  pip install -r requirements.txt
  pytest tools

External Links about GitHub Pages

How to Troubleshoot Building Project Locally

The project requires to use ruby>=3.1.*. Make sure that your system looks at the correct version of ruby.

Possible errors

Bundler error after bundle install command.

Setup ruby with rbenv

export PATH="$HOME/.rbenv/bin:$PATH" eval "$(rbenv init -)"

To install the correct ruby version, use the following command:

rbenv install 3.1.2

* Set the 3.1.* version of ruby as the default one globally or only for your working directory.

rbenv global 3.1.2 # set the default Ruby version for this machine

or:

rbenv local 3.1.2 # set the Ruby version for this directory



* Get back to the [Build and run](#build-and-run) section.

### Remove Gemfile.lock

As an alternative way, remove Gemfile.lock if setting Ruby version didn't help.

## How to Run End-To-End Testing Locally

1. Open your Terminal in the root directory.
2. `npm install cypress --save-dev` - This will install Cypress locally as a dev dependency for your project.
3. Run `npx cypress open` from your project root
4. Select E2E testing

![Open Cypress](https://i.ibb.co/4VNPFjf/welcome-cypress.png)

5. Select *E2E testing* option.

6. Choose your browser and click *Start E2E testing in..*..

![Browser Selection](https://i.ibb.co/kQxJpmJ/browser-selection.png)

Now you can run any tests from *Specs*.

For more details, please refer to the official [Cypress Documentation](https://docs.cypress.io/guides/overview/why-cypress).

<!-- MARKDOWN LINKS & IMAGES -->
[contributors-shield]: https://img.shields.io/github/contributors/WomenCodingCommunity/WomenCodingCommunity.github.io?style=flat-square
[contributors-url]: https://github.com/WomenCodingCommunity/WomenCodingCommunity.github.io/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/WomenCodingCommunity/WomenCodingCommunity.github.io?style=flat-square
[forks-url]: https://github.com/WomenCodingCommunity/WomenCodingCommunity.github.io/network/members
[stars-shield]: https://img.shields.io/github/stars/WomenCodingCommunity/WomenCodingCommunity.github.io?style=flat-square
[stars-url]: https://github.com/WomenCodingCommunity/WomenCodingCommunity.github.io/stargazers
[issues-shield]: https://img.shields.io/github/issues/WomenCodingCommunity/WomenCodingCommunity.github.io?style=flat-square
[issues-url]: https://github.com/WomenCodingCommunity/WomenCodingCommunity.github.io/issues/