Skip to content

freearhey/web-learn

Repository files navigation

Web Learn is an open source service which provides simple access to thousands of video lessons on web developing and programming.

Web Learn

Development

To start making any changes to the project, you first need to copy it to your computer using one of the available methods. For example, this can be done using the git clone command:

git clone https://github.com/freearhey/web-learn.git

Then you need to go to the project folder and install all the dependencies:

# change directory
cd web-learn

# install dependencies
npm install

The next step is to create the .env file in the project folder with the YouTube Data API key:

echo "YOUTUBE_API_KEY=YOUR_API_KEY_HERE" > .env

The key can be obtained via Google API Console: https://console.developers.google.com/

And after that you can start the development server:

npm run dev

and open the site in a browser. Usually the server starts at http://localhost:8080.

Contributing

If you find a bug or want to contribute to the code or documentation, you can help by submitting an issue or a pull request.

For example, if you want to add new topic to the site you only need to create a Yaml file inside the topics folder with its description:

nodejs.yml

id: nodejs # topic id
title: Node.js # full title of the topic
score: 149856 # number of questions on http://stackoverflow.com/tags
color: '#539e43' # usually the main color of the logo
site: http://nodejs.org # official site (optional)

License

MIT