lms/README.md

Community

This app helps people organize and manage their own communities.

The App has following components:

1. Hackathons
2. LMS

Community is built on the Frappe Framework, a full-stack web app framework built with Python & JavaScript.

Local Setup

To setup the repository locally follow the steps mentioned below:

1. Install bench and setup a frappe-bench directory by following the Installation Steps.
2. Start the server by running bench start.
3. In a separate terminal window, create a new site by running bench new-site community.test.
4. Run bench get-app https://github.com/fossunited/community.
5. Run bench --site community.test install-app community.
6. Map your site to localhost with the command bench --site community.test add-to-hosts
7. Now open the URL http://community.test:8000/docs in your browser, you should see the app running.

Contribution Guidelines

1. Go to the apps/community directory of your installation and execute git pull --unshallow to ensure that you have the full git repository. Also fork the fossunited/community repository on GitHub.
2. Check out a working branch in git (e.g. git checkout -b my-new-branch).
3. Make your proposed changes to the source
4. Run your local version (e.g. bench start in your bench installation). Make sure that your changes work the way you want them to.
5. Commit your changes to your branch. Make sure to use a semantic commit message.
6. Push your branch to your fork on Github, and issue a pull request.

License

AGPL