Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amzn/oss-contribution-tracker
Track contributions made to external projects and manage CLAs
https://github.com/amzn/oss-contribution-tracker
open-source-tooling
Last synced: 2 months ago
JSON representation
Track contributions made to external projects and manage CLAs
- Host: GitHub
- URL: https://github.com/amzn/oss-contribution-tracker
- Owner: amzn
- License: apache-2.0
- Archived: true
- Created: 2017-08-28T17:45:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-16T22:56:10.000Z (over 3 years ago)
- Last Synced: 2024-08-01T13:22:25.728Z (5 months ago)
- Topics: open-source-tooling
- Language: TypeScript
- Homepage:
- Size: 2.44 MB
- Stars: 40
- Watchers: 10
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ospo - OSS Contribution Tracker - Track contributions made to external projects and manage CLAs (Contributor License Agreements / Developer Certificate of Origins)
README
# OSS-Contribution-Tracker
[](https://github.com/amzn/oss-contribution-tracker/actions?query=workflow%3ACI)
OSS-Contribution-Tracker is a tool that tracks external contributions to third-party open source software and CLAs that are sometimes associated.
## Quickstart setup
1. Install [Docker](https://www.docker.com) for your platform of choice
2. Clone this repository to your machine
3. Edit `config/default.js` and fill out the ldap, admin, approver, and display sections
4. Run `docker-compose up`
5. Navigate to http://0.0.0.0:8000/ via your preferred browser
6. Log all the contributions
## Development server
If you are interested in setting up a development server for testing, or just want to mess with the code base, you can launch a dev environment by:
1. Running `npm install` (if you haven't already)
2. Run `docker-compose -f docker-compose.dev.yml up` to start up a PostgreSQL container
3. In a new shell, run `npm run dev` to launch a development/auto-reloading instance.
4. Navigate to http://0.0.0.0:8010/
### Using Alternate Configurations
You can provide a custom configuration by placing your config in the server/config directory and by running
`npm run dev --alt_config=`
### Testing
To run unit tests, run `npm test` from the root folder.
To run UI tests:
1. Run `docker-compose -f docker-compose.selenium.yml up` from the root directory
2. Run `npm run test-ui` from the root directory
**Note:** You can connect to the selenium instance through VNC to actually view the UI tests. This is useful when trying to troubleshoot or write new features.
### Environment Variables
Set `DEBUG_SQL=1` to show full SQL commands on the console.
Set `DEBUG_USER=$USER` to simulate a user during development. The default user is 'nobody'.
## Contributing
Read [CONTRIBUTING](CONTRIBUTING.md) for details.
### Editor Plugins
These plugins can assist in development and maintaining code style in this project:
### VS Code ###
* EditorConfig for VS Code
* TSLint