shoutouts.dev

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

Open Source is hard. Show your gratitude

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# shoutouts.dev

[![shoutouts.dev](https://shoutouts.dev/projects/yeraydiazdiaz/shoutouts.dev/badge)](https://shoutouts.dev/projects/yeraydiazdiaz/shoutouts.dev)

[shoutouts.dev](https://shoutouts.dev) is a website for OSS users to post public
messages of gratitude for projects they use and love.

shoutouts.dev is currently in **beta**, please use this repo to raise any issues
with the site and discuss possible improvements.

## Contributing

PRs are welcome. I am fairly new to Elixir and Phoenix, so any advice on best
practices is greatly appreciated.

### Dev setup

First you'll need to install:

- Elixir 1.11.2, probably best using your package manager.
- Node 14, [`nvm`](https://github.com/nvm-sh/nvm) works best.
- PostgreSQL 12, use Docker, your package manager, or [Postgres app](https://postgresapp.com/)
- Docker, for making releases.

Then:

1. `cd apps/shoutouts_web/assets/`
2. `npm i`
3. Back in the root dir, `mix deps.get`
4. Tweak the database settings depending on your setup
5. `mix ecto.create`
6. `mix ecto.migrate`
7. `mix run apps/shoutouts/priv/repo/seeds.exs`
8. `mix phx.server` or `mix test`

### Configuration

The configuration is split in several files in the `config` directory.

- `config.exs` includes common configuration options.
- `dev.exs` options for development
- `test.exs` for testing
- `prod.exs` for production
- `prod.secret.exs` is effectively empty as we use environment variables
via [Vapor](https://github.com/keathley/vapor), check each sub-app's
`application.exs` for more details.

Vapor will read from `config.yaml` placed in the project root, copy the
`config.template.yaml` file and edit accordingly.

### Frontend

We use [Tailwind CSS](https://tailwindcss.com/docs) and
[Stimulus](https://stimulus.hotwire.dev/) in conjunction with
[Phoenix's JS library](https://hexdocs.pm/phoenix/js/index.html).

The webpack configuration is modified from the default Phoenix includes:

- PostCSS is added for Tailwind CSS.
- PurgeCSS is included to reduce the CSS payload to include only those styles
used in the templates. **This means changing classes in the web inspector may
not work as expected as the new class may have been purged**. If you're
experiencing issues when making CSS changes it's worth commenting out the
PurgeCSS section in `postcss.config.js` until you're happy with the result.
- Fonts found in CSS are copied directly to /fonts/ and SVGs are included as
URLs so they will need to be used in CSS classes.

### Dependencies

As an umbrella project each app has its own mix.exs where dependencies are set.
Generally all web-specific dependencies should go on the web app's mix.exs
while "backend" deps on the base's.

### Releases

We use [Distillery](https://hexdocs.pm/distillery/home.html) to produce release
artifacts. These are built an Ubuntu 20.04 Docker image and a build bash
script that produces release tarballs executable in any Ubuntu 20.04 system.

`make release` will produce tarball with the release with the version number
in `apps/shoutouts/mix.exs`. Note there is another version in `shoutouts_web`
these should be change together to avoid confusion.

Pre-release checklist:

- Bump the version in both `mix.exs` files, we use a CalVer `YY.MAJOR.MINOR`.
- Update the changelog with the release version.
- Test the app using `make prod-server` to ensure production assets are correct.
- Run `make mac-release` to create a Mac release and test locally via Distillery
commands.
- Create an Ubuntu release and test locally in VMs.

### Provider integrations

#### GitHub

A GitHub OAuth App must be created to allow users to sign in with the
authorization callback URL set to `http://<DOMAIN>/auth/github/callback`,
in dev `http://localhost:4000`.

The app client ID and client secret need to be set in their respective
configuration variables.

Additionally a GitHub API token is used to retrieve public information about
the user.

## Sponsors

[AppSignal](https://appsignal.com), graciously provides free monitoring through
their [Open-Source and "For Good" initiative](https://appsignal.com/open-source).

shoutouts.dev

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README