Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/acm-uiuc/groot-desktop-frontend

Desktop Frontend for Groot
https://github.com/acm-uiuc/groot-desktop-frontend

expressjs frontend groot

Last synced: about 15 hours ago
JSON representation

Desktop Frontend for Groot

Awesome Lists containing this project

README

        

# Groot Desktop Frontend

[![Build Status](https://travis-ci.org/acm-uiuc/groot-desktop-frontend.svg?branch=master)](https://travis-ci.org/acm-uiuc/groot-desktop-frontend)

This is the repo for the frontend/website for groot. It's built desktop first and with a focus on a low barrier to entry for contributions. Good coding practices are encouraged as this repo should serve as an example on how to contribute to groot.

[![Join the chat at https://acm-uiuc.slack.com/messages/C6XGZD212/](https://img.shields.io/badge/slack-groot-724D71.svg)](https://acm-uiuc.slack.com/messages/C6XGZD212/)

## Local Set Up

1. Clone it!
2. Rename `example.env` to `.env` for environmental variables
3. run `npm install` or `yarn`
4. run `npm start`
5. Navigate to [localhost:5000](localhost:5000)

> If you want to set this up in a docker instance, either use port 5000 or set the **PORT** environment variable

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Credits

Groot was built by many human contributors, some of whom can be seen spending their days at the ACM office @ UIUC

## License

This project is licensed under the University of Illinois/NCSA Open Source License. For a full copy of this license take a look at the LICENSE file.

When contributing new files to this project, preappend the following header to the file as a comment:

```
Copyright © 2017, ACM@UIUC

This file is part of the Groot Project.

The Groot Project is open source software, released under the University of Illinois/NCSA Open Source License.
You should have received a copy of this license in a file with the distribution.
```