Initial commit

README.md

@@ -0,0 +1,62 @@
+# Confient
+
+A tiny [Phoenix](https://www.phoenixframework.org/) web app for teacher to
+collect students works
+
+## Getting Started
+
+### Prerequisites
+
+- [Elixir](https://elixir-lang.org/)
+
+### Installing
+
+#### Get Confient
+
+##### From source
+
+Clone this repo and run
+
+```sh
+mix deps.get
+```
+
+To download all the deps
+
+```sh
+cd assets && npm install
+```
+
+To get Node.js deps
+
+This apps needs a [PostgreSQL](https://www.postgresql.org/) data base
+
+As a startup you can une the one in `compose/dev`
+
+```sh
+cd compose/dev && docker-compose up
+```
+
+When DB is up, run the migrations
+
+```sh
+mix ecto.migrate
+```
+
+Then start the server
+
+```sh
+mix phx.server
+```
+
+Visit [`localhost:4000`](http://localhost:4000) from your browser : 🎉
+
+If you need details on how to run it in production, see [Phoenix deployment guides](https://hexdocs.pm/phoenix/deployment.html).
+
+## Authors
+
+- Wilfried OLLIVIER - Main author - [papey](https://git.athelas-conseils.fr/papey)
+
+## License
+
+[LICENSE](LICENSE) file for details