Skip to content

Latest commit

 

History

History
122 lines (85 loc) · 4.85 KB

README.md

File metadata and controls

122 lines (85 loc) · 4.85 KB
Raw


Learning English

🔗 learning-english.vercel.app 🟢

About the project • Getting started • License

About the project and its purpose

Learning English is a simple project, that aims to help people with interest in learning English language to do so through an interactive, visual and auditory stimuli.

Besides this project being a Progressive Web App, It's also open-source and accepting contribution to improve its usage and features.

Currently some of the incooperated features include:

  • Web Speech API 🔊
  • Dark Mode 🌙
  • Auto play audio ▶️
  • Open source
  • Easy to use

Wanna help improve the functionality of this App? Here is how to get involved.

Getting started and Contribution guide

To get started with this project, there are some steps you need to follow:

  1. Make sure to read the Contributing Guidelines and the Code of Conduct.
  2. Fork this repository
    By forking this repository, this will create a copy of this repository in your GitHub account. This is necessary because you need your own copy to work on the project, so that you have your own remote. The fork button is located at the top right corner of this page.
  3. Clone the repository
    Cloning the repo will allow you to have the project on your local machine. To clone the repo, run the following command in your terminal: git clone followed with the URl that points to your forked repo. This URL can be copied by clicking on the green button that says "Code" and copying the URL.
git clone <the-url-that-points-to-your-forked-repo>
  1. Switch to the repository directory
    By doing this you will be automatically switched to the project directory.
cd learning-english
  1. Create a branch
    By creating a separate branch you are isolating your changes from the main branch. This is a good practice because you can always switch back to the main branch if you want to update your forked repo with the original repo. To create a branch, run the following command:
git checkout -b <branch-name>
  1. Make necessary changes and commit those changes
    After you have created a new branch, you can now make the necessary changes. After you have made the changes, you need to add the changes and commit them. To add and commit all changes, run the following command:
    Add changes
git add .

Commit changes

git commit -m "<commit-message>"

By default since this is a web app you would want to see if changes you made we rendered correctly, for this you will need to test the project locally first.

In our case we will need to install all development dependencies of the project using the command:

npm install

and sfterwards start the development mode using tthe command:

npm run dev

This will start your project on localhost:9090 and you can see if your changes are rendered correctly. ✨

  1. Push changes to GitHub Finally if everything turns out fine, you can now proceed to pushing your changes to GitHub. To push your changes, run the following command:
git push origin <branch-name>
  1. Submit your changes for review
    If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button. This will open a new page where you can add a title and description to your pull request that explains your contribution. With that, you have submitted your changes for review. 🎉

License

This project is licensed under the MIT License.

Our Amazing Contributors ❤️

Thanks to these amazing people for contributing to this project:

list generated by contrib.rocks

Typing SVG