The code for openbook.social.
Table of contents
Requirements
- Node > 7.6
Project overview
The website is a Vue 2.x application.
Other relevant technologies used are
- Sass for stylesheets
- Bulma for kickstarting the styles/layout.
- Buefy for providing the logic to the Bulma 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 or any later version. 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.
Git commit message conventions
Help us keep the repository history consistent
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 git@github.com:OpenbookOrg/openbook-org-www.gitInstall the dependencies
$ npm installServe with hot reload at localhost:3000
$ npm run serveBuild for production
npm run build