|
| 1 | +[trello]: https://trello.com/whatever |
| 2 | +[build-page]: https://semaphore.com/whatever |
| 3 | +[production]: https://link.to.production/ |
| 4 | + |
| 5 | +PROJECT NAME |
| 6 | +============ |
| 7 | + |
| 8 | +Put the build badges here. |
| 9 | + |
| 10 | +* [Trello][trello] |
| 11 | +* [Build Page][build-page] |
| 12 | +* [Production][production] |
| 13 | +* ... |
| 14 | + |
| 15 | +Short project description. You can use the client's pitch. No more than ten lines. |
| 16 | + |
| 17 | +**Table of Contents** |
| 18 | + |
| 19 | +* [Setup](#setup) |
| 20 | +* [Development](#development) |
| 21 | +* [Deployment](#deployment) |
| 22 | +* [More Sections](#more-sections) |
| 23 | +* [Contribution Guidelines](#contribution-guidelines) |
| 24 | +* [Resources](#resources) |
| 25 | +* [Contacts](#contacts) |
| 26 | + |
| 27 | +Setup |
| 28 | +----- |
| 29 | + |
| 30 | +A set of instructions to install the project. It can start with a list of dependencies, like databases, and finish with the instructions. For instance: |
| 31 | + |
| 32 | +First clone the repository to your file system: |
| 33 | + |
| 34 | +``` |
| 35 | +git clone git@github.com:subvisual/guides.git |
| 36 | +``` |
| 37 | + |
| 38 | +After, run the setup script: |
| 39 | + |
| 40 | +``` |
| 41 | +bin/setup |
| 42 | +``` |
| 43 | + |
| 44 | +To finish, open the file `.env` and replace the values accordingly. |
| 45 | + |
| 46 | +Development |
| 47 | +----------- |
| 48 | + |
| 49 | +A set of instructions to run the project in development. For instance: |
| 50 | + |
| 51 | +To start your development environment run: |
| 52 | + |
| 53 | +``` |
| 54 | +bin/server |
| 55 | +``` |
| 56 | + |
| 57 | +This will start the node application, Redis, and Gulp. |
| 58 | +ProjectName uses Gulp to watch and compile frontend assets. |
| 59 | +To build the assets only once, not watching for changes, run: |
| 60 | + |
| 61 | +``` |
| 62 | +npm run build |
| 63 | +``` |
| 64 | + |
| 65 | +Deployment |
| 66 | +---------- |
| 67 | + |
| 68 | +Deploys can be manual or automatic. In both cases, write a short explanation about how it works: if the process is manual write the steps necessary to accomplish it; if the process is automatic, link to the page to consult the deployment status. Take the following as an example: |
| 69 | + |
| 70 | +To deploy the app run `bin/deploy` |
| 71 | + |
| 72 | +More Sections |
| 73 | +------------- |
| 74 | + |
| 75 | +This section is just a placeholder. You can replace it with any section or sections. Here you can write everything you feel the reader should know should about the project. This is the place to document other commands that are available to the user, or instructions on how to do something that's manual |
| 76 | + |
| 77 | +Contribution Guidelines |
| 78 | +----------------------- |
| 79 | + |
| 80 | +Contributions must follow [Subvisual's guides](https://github.com/subvisual/guides). |
| 81 | + |
| 82 | +Resources |
| 83 | +--------- |
| 84 | + |
| 85 | +This section should list every online resource that is relevante to the project. For instance: |
| 86 | + |
| 87 | +* Link to spec file on Goole Drive |
| 88 | +* Link to Invision files. |
| 89 | +* ... |
| 90 | + |
| 91 | +About |
| 92 | +----- |
| 93 | + |
| 94 | +ProjectName is maintained by [Subvisual](http://subvisual.co). |
| 95 | + |
| 96 | +[](http://subvisual.co) |
| 97 | + |
| 98 | +If you need to contact the maintainer use [this](https://trello.com/b/svB6ZSce/areas-of-responsability-dris) trello board, or reach out to <a href="mailto:contact@subvisual.co">Some One</a> if you don't have access. |
0 commit comments