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

Add "How-to-build" and "How-to-install" info on README #183

Closed
filfreire opened this issue Aug 16, 2018 · 4 comments
Closed

Add "How-to-build" and "How-to-install" info on README #183

filfreire opened this issue Aug 16, 2018 · 4 comments
Assignees
Milestone

Comments

@filfreire
Copy link

I suggest adding to the README file "how to build" the project locally and how to maybe install it (similarly to info on website), for any newcomers to find that info right on the README.

/cc @acelaya

@acelaya
Copy link
Member

acelaya commented Aug 16, 2018

That's a really good idea (improving the docs has been in the ToDo list since forever)

@robwent
Copy link
Contributor

robwent commented Sep 9, 2018

I was just searching for something similar.

As someone new to this, I'm getting stuck at a few points.

I've got the application installed (After installing apcu).

I assumed it had a backend but I see now that it's cli/rest only, but I have no idea how to create an api key.

I installed the react app in a subfolder which didn't work until I edited the file and corrected the paths to where I installed it.
Then trying to add a server, I realised I have no idea how to create an api key and can't find any docs on the available commands or how to list them.

@acelaya
Copy link
Member

acelaya commented Sep 9, 2018

Thanks for your insterest @robwent.

The docs need improvement, yes. I will work on it as soon as I have the time.

API keys can only be created from the CLI. Just run bin/cli api-key:generate. The command will output the generated API key.

You can see any available commands by simply running bin/cli with no arguments.

@robwent
Copy link
Contributor

robwent commented Sep 9, 2018

Yep, I feel a bit dumb now.

I just ran /bin/cli and got a list of all the commands!

@acelaya acelaya self-assigned this Sep 9, 2018
@acelaya acelaya added the task label Sep 9, 2018
@acelaya acelaya added this to the Next milestone Sep 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants