Skip to content

Commit

Permalink
add acknowledgements
Browse files Browse the repository at this point in the history
  • Loading branch information
@SanderGi
SanderGi committed Dec 19, 2024
1 parent f782e97 commit bedffd3
Show file tree
Hide file tree
Showing 6 changed files with 149 additions and 2,388 deletions.
5 changes: 2 additions & 3 deletions .github/pull_request_template.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@

### Q/A checklist

- [ ] If you added new dependencies, did you update the requirements.txt file? `pip freeze > requirements.txt`
- [ ] Run formatting, linting, tests, and security checks `. scripts/alltests.sh`
- [ ] If you added new dependencies, double-check there are no security vulnerabilities with `npm audit`, make sure they are well maintained, and generate a license report with `npm run license-report`. The report should be updated in [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md) and the license for the dependency should be compatible with the [FSL-1.1-Apache-2.0](https://fsl.software/) license.
- [ ] Run formatting, linting, tests, and security checks (see [DEVELOPMENT.md](DEVELOPMENT.md))
- [ ] Do a self code review of the changes - Read the diff at least twice.
- [ ] I have written tests for any new features and regression tests for any bug fixes.
- [ ] If you changed/updated/added ML models, did you update `scripts/Dockerfile.prod` to cache the weights?

### Legal Boilerplate

Expand Down
70 changes: 70 additions & 0 deletions ACKNOWLEDGEMENTS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Individual Contributors

If you wish to be acknowledged for your contributions, please list your name
with a short description of your contribution(s) below. For example:

- Jane Smith: Added the `foo` and `bar` ops.

The Koel Labs Web Application was developed with contributions from the following individuals:

- [Ruslan Mukhamedvaleev](https://www.ruslan.in/): Koel Labs co-founder and lead web-developer and designer.
- [Alexander Metzger](https://www.linkedin.com/in/alexander-le-metzger): Koel Labs co-founder and CEO and lead backend+infrastructure+devops+ML engineer.

<a href="https://github.com/KoelLabs/webapp/graphs/contributors">
<img class="dark-light" src="https://contrib.rocks/image?repo=KoelLabs/webapp&anon=0&columns=20&max=100&r=true" />
</a>

# Third-Party Software

| Name | License period | License type | Link | Author |
| :---------------------------------- | :------------- | :----------- | :----------------------------------------------------------------------------- | :-------------------------------------------------------------------- |
| @custom-react-hooks/use-media-query | perpetual | MIT | git+https://github.com/djkepa/custom-react-hooks.git | Bane Grozdanovic <[email protected]> |
| @headlessui/react | perpetual | MIT | git+https://github.com/tailwindlabs/headlessui.git | n/a |
| @radix-ui/react-avatar | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-checkbox | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-collapsible | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-context-menu | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-dialog | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-dropdown-menu | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-icons | perpetual | MIT | https://registry.npmjs.org/@radix-ui/react-icons/-/react-icons-1.3.2.tgz | n/a |
| @radix-ui/react-label | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-popover | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-progress | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-select | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-separator | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-slider | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-slot | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-tabs | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @radix-ui/react-tooltip | perpetual | MIT | git+https://github.com/radix-ui/primitives.git | n/a |
| @vidstack/react | perpetual | MIT | https://github.com/vidstack/player.git | n/a |
| class-variance-authority | perpetual | Apache-2.0 | git+https://github.com/joe-bell/cva.git | Joe Bell (https://joebell.co.uk) |
| clsx | perpetual | MIT | git+https://github.com/lukeed/clsx.git | Luke Edwards [email protected] https://lukeed.com |
| drizzle-orm | perpetual | Apache-2.0 | git+https://github.com/drizzle-team/drizzle-orm.git | Drizzle Team |
| embla-carousel-react | perpetual | MIT | git+https://github.com/davidjerleke/embla-carousel | David Jerleke |
| firebase | perpetual | Apache-2.0 | git+https://github.com/firebase/firebase-js-sdk.git | Firebase <[email protected]> (https://firebase.google.com/) |
| firebase-admin | perpetual | Apache-2.0 | git+https://github.com/firebase/firebase-admin-node.git | Firebase <[email protected]> (https://firebase.google.com/) |
| framer-motion | perpetual | MIT | git+https://github.com/motiondivision/motion.git | Framer |
| lucide-react | perpetual | ISC | git+https://github.com/lucide-icons/lucide.git | Eric Fennis |
| media-chrome | perpetual | MIT | git+https://github.com/muxinc/media-chrome.git | @muxinc |
| next | perpetual | MIT | git+https://github.com/vercel/next.js.git | n/a |
| next-themes | perpetual | MIT | git+https://github.com/pacocoursey/next-themes.git | n/a |
| pg | perpetual | MIT | git://github.com/brianc/node-postgres.git | Brian Carlson <[email protected]> |
| postcss | perpetual | MIT | git+https://github.com/postcss/postcss.git | Andrey Sitnik <[email protected]> |
| react | perpetual | MIT | git+https://github.com/facebook/react.git | n/a |
| react-dom | perpetual | MIT | git+https://github.com/facebook/react.git | n/a |
| recharts | perpetual | MIT | git+https://github.com/recharts/recharts.git | recharts group |
| tailwind-merge | perpetual | MIT | git+https://github.com/dcastil/tailwind-merge.git | Dany Castillo |
| tailwind-scrollbar-hide | perpetual | MIT | git+https://github.com/reslear/tailwind-scrollbar-hide.git | reslear |
| tailwindcss | perpetual | MIT | git+https://github.com/tailwindlabs/tailwindcss.git | n/a |
| tailwindcss-animate | perpetual | MIT | https://registry.npmjs.org/tailwindcss-animate/-/tailwindcss-animate-1.0.7.tgz | Jamie Kyle <[email protected]> |
| vaul | perpetual | MIT | git+https://github.com/emilkowalski/vaul.git | Emil Kowalski <[email protected]> |
| zod | perpetual | MIT | git+https://github.com/colinhacks/zod.git | Colin McDonnell <[email protected]> |
| @types/node | perpetual | MIT | https://github.com/DefinitelyTyped/DefinitelyTyped.git | n/a |
| @types/react | perpetual | MIT | https://github.com/DefinitelyTyped/DefinitelyTyped.git | n/a |
| dotenv | perpetual | BSD-2-Clause | git://github.com/motdotla/dotenv.git | n/a |
| drizzle-kit | perpetual | MIT | git+https://github.com/drizzle-team/drizzle-orm.git | Drizzle Team |
| eslint | perpetual | MIT | git+https://github.com/eslint/eslint.git | Nicholas C. Zakas <[email protected]> |
| eslint-config-next | perpetual | MIT | git+https://github.com/vercel/next.js.git | n/a |
| eslint-config-prettier | perpetual | MIT | git+https://github.com/prettier/eslint-config-prettier.git | Simon Lydell |
| fixpack | perpetual | MIT | git://github.com/henrikjoreteg/fixpack.git | Henrik Joreteg <[email protected]> |
| prettier | perpetual | MIT | git+https://github.com/prettier/prettier.git | James Long |
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- If it repeatedly complains about the daemon not running, make sure Docker Desktop is running and add `export DOCKER_HOST=unix:///Users/$USER/Library/Containers/com.docker.docker/Data/docker.raw.sock` to your shell profile (e.g. `~/.zshrc`)
- [Docker Desktop for Windows](https://docs.docker.com/docker-for-windows/install/) or `choco install docker-desktop` with [Chocolatey](https://chocolatey.org/)
- [Docker Engine for Linux](https://docs.docker.com/engine/install/) or `sudo apt install docker.io` with APT on Ubuntu
2. Duplicate the `.env.example` file and rename it to `.env.local` with `cp .env.example .env.local`.
2. Duplicate the `.env.example` file and rename it to `.env.local` with `cp .env.example .env.local`.
- Comment out `DEV_LOGIN` and add your `FIREBASE_SERVICE_ACCOUNT` to enable authentication checks (login with Google etc.). You can leave in the `DEV_LOGIN` for offline development and other cases where you can't connect to the Firebase Auth server.
3. Run the application
- `. ./scripts/docker-run-dev.sh` to start the development server (or `npm run docker` if you have Node.js installed)
Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@ See [DEVELOPMENT.md](DEVELOPMENT.md) for how to setup your local development env
0. `git clone https://github.com/KoelLabs/webapp.git`
1. Install [Docker and Docker Compose](https://www.docker.com/get-started/)
2. Duplicate the `.env.example` file and rename it to `.env.local` with `cp .env.example .env.local`.
- The default values should work to get started. You can optionally change `DEV_LOGIN` to include your username and email.
- The default values should work to get started. You can optionally change `DEV_LOGIN` to include your username and email.
3. Run the application `. ./scripts/docker-run-dev.sh`

## Contributing

Check out [CONTRIBUTING.md](CONTRIBUTING.md) for specific guidelines on contributing to this repository.

We are grateful for all of [our contributors](ACKNOWLEDGEMENTS.md). If you contribute to this repository and wish to be acknowledged, please add your name to the list in your pull request.

## License

Application code in this repository is open-sourced under the [FSL-1.1-Apache-2.0](https://fsl.software/).
Expand Down
Loading

0 comments on commit bedffd3

Please sign in to comment.