Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make development setup easier #11

Closed
1 task
th0mas opened this issue Jul 10, 2020 · 2 comments · Fixed by #23
Closed
1 task

Make development setup easier #11

th0mas opened this issue Jul 10, 2020 · 2 comments · Fixed by #23

Comments

@th0mas
Copy link
Contributor

th0mas commented Jul 10, 2020

Currently setting up a development environment is a pain due to there being no clear way to generate auth tokens for the API.

I think(?) theres a function in Auth_plug that can generate Auth tokens client side, we should see if we can add this to a Mix command

  • Add a command to generate an Auth token automatically for development
@th0mas
Copy link
Contributor Author

th0mas commented Aug 26, 2020

Making development setup easier is a very broad term, here are a few ideas that could help:

  • Documentation: We can increase documentation and add some helper commands to make creating and developing auth keys easier but still require manually obtaining and starting the development servers.

  • Docker: Try for a 1 click install by running docker-compose up. This can have an added benefit of a controlled development environment but will require a large amount of upfront cost.

  • Scripts: Try for a 1 click install using shell/python(?) scripts that will pull and set everything up. These may not always work (e.g. Linux/Mac/Windows) differences but will be a lot lighter to run/less dependencies

@nelsonic thoughts?

@nelsonic
Copy link
Member

@th0mas Yeah, creating Auth API Keys is not going to be easier.
We've got it down to a single environment variable.
(unless you can think of a way to automate it...?)

Please note: the UI for Auth API Key creation is going to change shortly due to the creation of "Apps" dwyl/auth#95
But it will be the same number of steps and single environment variable. I will update the screenshots/steps in my PR.

As for using Docker, unless we are deploying using docker (and don't have any other choice),
I would prefer to avoid it because it's another thing to have to maintain/update.
While we have a precedent for using Docker see: https://github.com/dwyl/learn-docker#docker-and-pete-stack
@SimonLab is using it to run Postgres on his machine: dwyl/learn-docker#15 (comment)
I'd prefer to attempt the (well commented/documented) Python approach if possible,
but it depends on your estimate for how long you think it will take.

Not at all concerned about this working on Windows. In fact I would add "Microsoft Windows Not Supported" to the README.md to avoid any issues from people attempting to run it. We will never use Windows for anything secure. 💔

@th0mas th0mas closed this as completed in #23 Oct 2, 2020
th0mas added a commit that referenced this issue Oct 2, 2020
Automatic install scripts for #11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants