https://github.com/fossunited/fossunited
fossunited.org
https://github.com/fossunited/fossunited
Last synced: about 2 months ago
JSON representation
fossunited.org
- Host: GitHub
- URL: https://github.com/fossunited/fossunited
- Owner: fossunited
- License: agpl-3.0
- Created: 2023-06-26T06:22:10.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-08T20:42:47.000Z (about 2 months ago)
- Last Synced: 2025-04-09T20:00:50.359Z (about 2 months ago)
- Language: Vue
- Homepage: https://docs.fossunited.org/
- Size: 18 MB
- Stars: 114
- Watchers: 8
- Forks: 46
- Open Issues: 137
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
## The FOSS United Platform
Repo for the website and open-source platform of FOSS United. The whole platform is being built on [Frappe](https://frappe.io).
## 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](https://frappeframework.com/docs/) for setting up frappe on your [bench](https://frappeframework.com/docs/user/en/tutorial/install-and-setup-bench).
- If you encounter a password-related error after installing MariaDB while following the Frappe installation guide—despite not setting a password—follow [this DigitalOcean guide](https://www.digitalocean.com/community/tutorials/how-to-reset-your-mysql-or-mariadb-root-password) to reset the root password. If the `kill` command near the end of the article fails, find the MySQL processes using `ps aux | grep mysqld`, identify the `mysqld` and `mysql_safe` processes, and terminate them with `sudo kill -9 `. Verify that the processes are no longer running before proceeding.
- 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](https://frappeframework.com/docs/user/en/tutorial/create-a-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](https://frappeframework.com/docs/user/en/tutorial/create-a-site#access-site-in-your-browser) for adding hosts.
### Steps to install and run the [FOSS United Dashboard](https://fossunited.org/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`.
- In a development environment, you need to put the below key-value pair in your site_config.json file: `"ignore_csrf": 1`.
- Run the dashboard in the root directory of the project with `yarn dev`.
- Dashboard will now be accessible on `: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](/CONTRIBUTING.md).
### Security Policy
Please checkout [Security Policy](/SECURITY.md) for information about reporting a Security Bug or Vulnerability.
## License
The repository has been released under [AGPL-3.0](https://github.com/fossunited/fossunited/blob/develop/LICENSE).
By Contributing to the FOSS United Platform, you agree that all your contributions will be licensed under AGPL License.