-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,31 +3,32 @@ | |
|
|
||
| [](https://travis-ci.org/reimagined/resolve) [](https://badge.fury.io/js/create-resolve-app) [](https://raw.githubusercontent.com/reimagined/resolve/master/LICENSE) | ||
|
|
||
| A JavaScript framework for **CQRS**, **Domain-Driven Design** and **Event Sourcing** with support for **React** and **Redux**. **reSolve** provides a new way to describe an app's core logic and fully separate it from auxiliary code. | ||
| A JavaScript framework for **CQRS**, **Domain-Driven Design** and **Event Sourcing** with the **React** and **Redux** support. **reSolve** provides a new way to describe an app's core logic and completely separate it from auxiliary code. | ||
|
|
||
| ### <a name="installation">Installation</a> | ||
| ## Installation | ||
|
|
||
| The [create-resolve-app](packages/create-resolve-app) package is used to create a **reSolve**-based application. You can use it to get one of the examples, or create an empty application. By default, `create-resolve-app` generates an empty [Hello World](https://github.com/reimagined/resolve/tree/master/examples/hello-world) application. | ||
|
|
||
|
|
||
| Use the [create-resolve-app](packages/create-resolve-app) package to create an empty or sample **reSolve**-based application. By default, `create-resolve-app` generates an empty [Hello World](https://github.com/reimagined/resolve/tree/master/examples/hello-world) application. | ||
|
|
||
| ```sh | ||
| npx create-resolve-app my-awesome-app | ||
| cd my-awesome-app | ||
| npm run dev | ||
| ``` | ||
|
|
||
| The created application is accessible using the http://localhost:3000/ and `http://<your_ip>:3000/` URLs (you can [change the URL settings](https://github.com/reimagined/resolve/blob/master/docs/API%20References.md)). | ||
| Your new application is accessible using the http://localhost:3000/ URL (you can [change the URL settings](https://github.com/reimagined/resolve/blob/master/docs/API%20References.md)). | ||
|
|
||
| ### <a name="examples">Examples</a> | ||
| ## Examples | ||
|
|
||
| You can get a sample app using the `create-resolve-app` tool with the `-e` flag followed by an example name. Use the `create-resolve-app -h` command to list the available examples. | ||
|
|
||
| The following tools are used to get a sample **reSolve** application: | ||
| You can get a sample app using the [create-resolve-app](packages/create-resolve-app) tool with the `-e` flag followed by an example name: | ||
|
|
||
| ```sh | ||
| npx create-resolve-app todo-example -e todo | ||
| ``` | ||
|
|
||
| The `create-resolve-app` can is capable of creating the following apps: | ||
| The `create-resolve-app -h` command lists all available examples: | ||
|
|
||
|
|
||
| * [**hacker-news**](https://github.com/reimagined/resolve/tree/master/examples/hacker-news) | ||
| * [**hello-world**](https://github.com/reimagined/resolve/tree/master/examples/hello-world) | ||
|
|
@@ -38,15 +39,15 @@ The `create-resolve-app` can is capable of creating the following apps: | |
| * [**with-postcss-modules**](https://github.com/reimagined/resolve/tree/master/examples/with-postcss-modules) | ||
| * [**with-styled-components**](https://github.com/reimagined/resolve/tree/master/examples/with-styled-components) | ||
|
|
||
| ### <a name="get-in-touch">**Get in Touch**</a> | ||
| ## Get in Touch | ||
|
|
||
| Feel free to contact us if you have any questions! | ||
| Feel free to contact us! | ||
|
|
||
| * We are glad to see your e-mails sent to **[email protected]**. | ||
| * Follow us on [**Twitter**](https://twitter.com/resolvejs). We post interesting arcticles, announcements, post polls about **reSolve** development and talk about the modern web technologies! | ||
| * Follow us on [**Twitter**](https://twitter.com/resolvejs). We are tweeting interesting articles, announcements, polls about **reSolve** development, and talking about the modern web technologies! | ||
| * We also have a [**Facebook**](https://www.facebook.com/resolvejs/) page, join us! | ||
| * You can find our articles on [**Medium**](https://medium.com/resolvejs) | ||
| * You are welcome to post any questions or suggestions in [**GitHub Issues**](https://github.com/reimagined/resolve/issues) | ||
| * Our articles are hosted on [**Medium**](https://medium.com/resolvejs). | ||
| * You are welcome to submit any questions or suggestions in [**GitHub Issues**](https://github.com/reimagined/resolve/issues). | ||
| * Feel yourself capable of improving **reSolve**? Become one of our [**contributors**](https://github.com/reimagined/resolve/pulls)! Look through our [**Contrubutors Guide**](https://github.com/reimagined/resolve/blob/master/docs/Contributors%20Guide.md) and make a great Pull Request. | ||
| * Remember to star our **GitHub** repository if you like **reSolve**! | ||
|
|
||
|
|
||