Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/conradfr/NameGuess
https://github.com/conradfr/NameGuess
elixir-lang elixir-phoenix liveview phoenix
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/conradfr/NameGuess
- Owner: conradfr
- License: gpl-2.0
- Created: 2019-10-11T14:10:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-16T15:19:15.000Z (over 1 year ago)
- Last Synced: 2024-01-17T03:31:13.456Z (5 months ago)
- Topics: elixir-lang, elixir-phoenix, liveview, phoenix
- Language: Elixir
- Size: 1.17 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - conradfr/NameGuess - (Elixir)
README
# NameGuess
A company game, matching pictures of employees to names.
Demo (with some special colleagues) : https://nameguess.funkybits.fr
## Dependencies
* Elixir
* Postgresql
* Node / Npm
* ImageMagick
## Install project
1. Configure app_config.exs & ENV.secret.exs in /config based on .dist templates (dev) or env vars (prod)
2. Adapt the datasources [read about datasources](#datasources)
## Init project
1. mix deps.get
2. cd assets && npm install && node node_modules/webpack/bin/webpack.js --mode development
3. mix ecto.create
4. mix ecto.migrate
5. add at least one entry in the space table
## Start
To start your Phoenix server:
`iex -S mix phx.server` or `mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
## Command
In an iex session:
* Updating people: NameGuess.Update.people()
* Updating pictures: NameGuess.Update.pictures()
* Clean way to stop the server: :init.stop()
Tests: mix test
Datasources are modules in /lib/nameguess/datasource, implementing the NameGuess.DataSource behaviour.
Three datasource are included, BambooHR, Wikipedia POTUS (demo) and Local. Local uses a json file to import people, an example is included in /priv/data, pictures should go in /priv/pics_local and use the jpeg format.
Datasources are updated by default every night, pictures are updated once a week. These tasks schedule is defined in /config/config.exs.