The FOSS United Platform

Repo for the website and open-source platform of FOSS United. The whole platform is being built on Frappe.

Installation

• This project works the best on the latest Frappe Version v15. And is suggested to be installed on the same.

• Checkout Frappe Framework Installation Docs for setting up frappe on your bench.

• Create a new bench with bench init fossu-bench

• Clone the FOSS United Platform App. bench get-app https://github.com/fossunited/fossunited

• Create a new site bench new-site test.localhost

• Install the App on the created site bench --site test.localhost install-app fossunited

• Finally, bench start

Checkout Access site in your browser for adding hosts.

Steps to install and run the FOSS United Dashboard

The FOSS United Dashboard is a centralised admin UI for all the users signed up on fossunited.org. The Dashboard provides volunteers with the feature to manage all of the activities happening in their FOSS Club or City Chapter. Here are the steps to install and get the dashboard going:

• The code for dashboard is located under fossunited/dashboard.
• Install and Build the dashboard with yarn install.
• Run the dashboard in the root directory of the project with yarn dev.
• Dashboard will now be accessible on <sitename>:8080.

Pre-commit

For automatic running of linters before you commit:

$ pip install pre-commit
$ pre-commit install

Contribution

Want to contribute to the platform ? Checkout the contribution guidelines.

Security Policy

Please checkout Security Policy for information about reporting a Security Bug or Vulnerability.

License

The repository has been released under AGPL-3.0. By Contributing to the FOSS United Platform, you agree that all your contributions will be licensed under AGPL License.