|
1 |
| -# Project Name |
| 1 | +# Hog Store |
2 | 2 |
|
3 | 3 | [](./LICENSE)
|
4 |
| -[](https://moduscreate.com) |
| 4 | +[](https://moduscreate.com?utm_source=labs&utm_medium=github&utm_campaign=hog-store) |
5 | 5 |
|
6 |
| -Project description - one or two paragraphs. The enemy is dark and creates major problems. The solution is now available and the World can rejoice. |
7 |
| - |
8 |
| -- [Getting Started](#getting-started) |
9 |
| -- [How it Works](#how-it-works) |
10 |
| -- [Developing](#developing) |
11 |
| - - [Prerequisites](#prerequisites) |
12 |
| - - [Testing](#testing) |
13 |
| - - [Contributing](#contributing) |
14 |
| -- [Modus Create](#modus-create) |
15 |
| -- [Licensing](#licensing) |
| 6 | +Hog store is a sample application used for best-practice demonstrations on [Modus Create's YouTube Channel](https://youtube.com/moduscreate). |
16 | 7 |
|
17 | 8 | # Getting Started
|
18 | 9 |
|
19 |
| -{Minimal steps required for a quick software trial.} |
20 |
| - |
21 |
| -```js |
22 |
| -import { Fantastico } from '@modus/awesome-solution'; |
23 |
| - |
24 |
| -const amazing = new Fantastico(); |
| 10 | +Use NPM or Yarn to install dependencies. |
25 | 11 |
|
26 |
| -export default amazing; |
| 12 | +```bash |
| 13 | +npm install |
27 | 14 | ```
|
28 | 15 |
|
29 |
| -# How it works |
30 |
| - |
31 |
| -{Describe how it works. Include images if possible.} |
32 |
| - |
33 |
| -# Developing |
34 |
| - |
35 |
| -{Show how engineers can set up a development environment and contribute.} |
| 16 | +```bash |
| 17 | +yarn |
| 18 | +``` |
36 | 19 |
|
37 |
| -## Prerequisites |
| 20 | +This app is bootstraped with Create React App (CRA). All the usual CRA commands work. |
38 | 21 |
|
39 |
| -{Explain the prerequisites} |
| 22 | +Useful scripts (npm/yarn): |
40 | 23 |
|
41 |
| -## Testing |
| 24 | +- `yarn start` - start dev server |
| 25 | +- `yarn build` - build the app |
| 26 | +- `yarn test` - test runner |
42 | 27 |
|
43 |
| -{Notes on testing} |
| 28 | +# Running in production |
44 | 29 |
|
45 |
| -## Contributing |
| 30 | +Ensure you have `serve` installed globally. |
| 31 | +You need to build before running in production. |
46 | 32 |
|
47 |
| -{How can the community contribute} |
| 33 | +```bash |
| 34 | +serve -s build |
| 35 | +``` |
48 | 36 |
|
49 | 37 | # Modus Create
|
50 | 38 |
|
51 |
| -{replace PROJECT_NAME in links below with the name of this project} |
52 |
| - |
53 | 39 | [Modus Create](https://moduscreate.com) is a digital product consultancy. We use a distributed team of the best talent in the world to offer a full suite of digital product design-build services; ranging from consumer facing apps, to digital migration, to agile development training, and business transformation.
|
54 | 40 |
|
55 |
| -<a href="https://moduscreate.com/?utm_source=labs&utm_medium=github&utm_campaign=PROJECT_NAME"><img src="https://res.cloudinary.com/modus-labs/image/upload/h_80/v1533109874/modus/logo-long-black.svg" height="80" alt="Modus Create"/></a> |
| 41 | +<a href="https://moduscreate.com/?utm_source=labs&utm_medium=github&utm_campaign=hog-store"><img src="https://res.cloudinary.com/modus-labs/image/upload/h_80/v1533109874/modus/logo-long-black.svg" height="80" alt="Modus Create"/></a> |
56 | 42 | <br />
|
57 | 43 |
|
58 |
| -This project is part of [Modus Labs](https://labs.moduscreate.com/?utm_source=labs&utm_medium=github&utm_campaign=PROJECT_NAME). |
| 44 | +This project is part of [Modus Labs](https://labs.moduscreate.com/?utm_source=labs&utm_medium=github&utm_campaign=hog-store). |
59 | 45 |
|
60 |
| -<a href="https://labs.moduscreate.com/?utm_source=labs&utm_medium=github&utm_campaign=PROJECT_NAME"><img src="https://res.cloudinary.com/modus-labs/image/upload/h_80/v1531492623/labs/logo-black.svg" height="80" alt="Modus Labs"/></a> |
| 46 | +<a href="https://labs.moduscreate.com/?utm_source=labs&utm_medium=github&utm_campaign=hog-store"><img src="https://res.cloudinary.com/modus-labs/image/upload/h_80/v1531492623/labs/logo-black.svg" height="80" alt="Modus Labs"/></a> |
61 | 47 |
|
62 | 48 | # Licensing
|
63 | 49 |
|
|
0 commit comments