Okuna is coming to the web.

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

• node

The project is a Nuxt application.

It's dependent on the okuna-api backend, be it whether you host your own or use the Okuna backend at https://api.openbook.social/

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

Please read and follow our Code of Conduct.

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.

Cyber-hero? Check out our Vulnerability Disclosure page.

We're available almost 24/7 in the Okuna slack channel. Join us!

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.

$ npm install

$ copy .sample.env .dev.env
$ copy .sample.env .prod.env
$ nano .{dev|prod}.env

$ npm run dev

$ npm run generate

For detailed explanation on how things work, checkout the Nuxt.js docs.