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

Readme improvements #10

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

rafacm
Copy link

@rafacm rafacm commented Mar 29, 2018

  • Add demo screenshot
  • Fix links to files
  • Add info about how to start a local Mesh instance
  • Add info about proxy configuration

Fixes #9

@leonadler leonadler self-requested a review March 30, 2018 08:47
@leonadler leonadler self-assigned this Mar 30, 2018
README.md Outdated
are necessarily naive. The idea is to provide a way to see the Mesh API in action and provide an example for
Once the Gentics Mesh local instance is up and running you can start the example with
`npm run-script start` which will start a dev server at [http://localhost:4200/](http://localhost:4200/).
You can also use `npm run-script start` to build the project to the `dist/` directory.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-> npm start / yarn start serves the project, npm run build / yarn build builds the project to dist/

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 9552f8e

README.md Outdated
```
docker run -p 8080:8080 gentics/mesh-demo
```
Check the [documentation](https://getmesh.io/docs/beta/administration-guide.html#_run_with_docker) for details and other options.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also include the non-docker instructions

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 9552f8e

README.md Outdated
This is intended to be an extremely simple example. Therefore the implementations
are necessarily naive. The idea is to provide a way to see the Mesh API in action and provide an example for
Once the Gentics Mesh local instance is up and running you can start the example with
`npm run-script start` which will start a dev server at [http://localhost:4200/](http://localhost:4200/).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the URL would be http://localhost:4200/demo (but I'll check back, as per this comment)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 9552f8e

@rafacm
Copy link
Author

rafacm commented Mar 30, 2018

@leonadler: done!

@CLAassistant
Copy link

CLAassistant commented Jul 4, 2019

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README.md improvements
3 participants