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

TODO check that readme is up to date #74

Open
0xlyd opened this issue Mar 27, 2020 · 1 comment
Open

TODO check that readme is up to date #74

0xlyd opened this issue Mar 27, 2020 · 1 comment
Labels
documentation Something related to doubts information about developed code

Comments

@0xlyd
Copy link
Contributor

0xlyd commented Mar 27, 2020

Some indications:

  • I would rename this from JUR MVP to Jur Platform (keep in mind that "JUR" stands for the token whereas "Jur" is the company and the project's name). Let's not make this confusion in the code as well

  • the storybook badge is not rendering and there are some that we could add up

  • remove space before colon e.g. master : is a mirror of production environment;

  • adding the "bash" symbol in commands makes it difficult to copy/paste them

  • can we add the actual changelog here? It will help in the future https://github.com/jurteam/platform/blob/master/CHANGELOG.md

Update:

  • I think also instructions here are not updated. The Dockerfile seems to contain some wrong paths and the following is no more true as well I guess?
cd path/to/project/root
$ docker-compose build
$ docker-compose up -d
$ **docker exec -it php bash**
$ cd ..
$ composer install
$ php artisan key:generate
$ php artisan migrate:refresh
$ php artisan db:seed
@0xlyd 0xlyd added the documentation Something related to doubts information about developed code label Mar 27, 2020
@0xlyd
Copy link
Contributor Author

0xlyd commented Apr 2, 2020

@marcomarasco I think we can follow the order/clean structure of this README to tide it up a bit

https://github.com/ai/size-limit#readme

Anyway please go ahead then we can review it together 👍 (let's add the steps for running solo, testnet, mainnet)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something related to doubts information about developed code
Projects
None yet
Development

No branches or pull requests

2 participants