search

TEA-ebook / teabook-open-reader

TeaBook Open Reader - EPUB web reader, with offline access
Other
127 stars 32 forks source link

Getting started instructions #8

Closed j15e closed 11 years ago

j15e commented 11 years ago

Hi!

Just gave a try, so I added instruction to setup the project.

I haven't found how you expect to create/manage users, you should add this to the getting started instructions I made if possible

Thank you

eunomie commented 11 years ago

Hi,

Thanks for your comment. As you have seen the documentation is not yet complete. This will happen gradually.

User accounts are not in the application. They are in another server and the communication is done via an API. To test the application, a fake API is available. You can launch it by running the command

bundle exec shotgun tea_api.ru-p 4567

With the fake API, authentication always responds ok.

Even if it does not answer the question exactly, you can find some additional instructions in the commit e9e528e870 to create a vagrant virtual machine to test the application.

j15e commented 11 years ago

Thx for the details

Can you merge my instructions as a starting point?

nono commented 11 years ago

At least, there should be a link to https://github.com/TEA-ebook/teabook-open-reader/wiki/Installation in the README. It's not obvious to find it when you have git cloned the repos and are trying to use it.

eunomie commented 11 years ago

You can find a more detailed readme here https://github.com/CrEv/teabook-open-reader/tree/readme

eunomie commented 11 years ago

I've commited a more detailed readme (0c602b13c6)

I added some commands from your commit (rails g/s commands) in addition to those used in general

Thanks