What is this?

This is the code for www.open-book.org.

Table of contents

• Requirements
• Project overview
• Contributing
  • Code of Conduct
  • License
  • Other issues
  • Git commit message conventions
• Getting started

Requirements

• Node > 7.6

Project overview

The website is completely static (no backend server needed) and comprises of a single HTML page.

The technologies used are

• Sass for stylesheets
• Bulma for kickstarting the basic styles
• Vue 2 with ES6 for custom JavasScript components
• Webpack 4 for bundling everything together

Contributing

There are many different ways to contribute to the website development, just find the one that best fits with your skills and open an issue/pull request in the repository.

Examples of contributions we love include:

• Code patches
• Bug reports
• Patch reviews
• Translations
• UI enhancements

Code of Conduct

Please read and follow our Code of Conduct.

License

Every contribution accepted is licensed under AGPL v3.0. You must be careful to not include any code that can not be licensed under this license.

Please read carefully our license and ask us if you have any questions.

Other issues

We have a keybase public channel where you can talk to us!

Git commit message conventions

Help us keep the repository history clean 🙏!

We use gitmoji as our git message convention.

If you're using git in your command line, you can download the handy tool gitmoji-cli.

Getting started

Clone the repository

git clone [email protected]:OpenBookOrg/www.open-book.org.git

Install the dependencies

npm install

Start the development server

npm start

Building the project for production

npm run build

Previewing the production build

npm run preview

Happy coding 🎉!