-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[#11] Add basic readme & update gitignore for additional files
- Loading branch information
Showing
3 changed files
with
97 additions
and
11 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Veterans of War Aid Foundation | ||
|
||
## Table of Contents | ||
|
||
- [Requirements](#requirements) | ||
- [Getting Started](#getting-started) | ||
- [Testing](#testing) | ||
- [Deployment](#deployment) | ||
|
||
## Requirements | ||
|
||
- [npm](https://www.npmjs.com/get-npm) | ||
- Understand the [GitFlow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) | ||
>This is the workflow we utilize across the project for branching method. | ||
## Getting Started | ||
|
||
1. Install packages | ||
|
||
```bash | ||
npm i | ||
``` | ||
|
||
2. Start project | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
3. The application is now running on http://localhost:3000. | ||
|
||
>Nuxt.js will listen for file changes inside the pages directory, so there is no need to restart the application when adding or updating pages. | ||
|
||
## Testing | ||
|
||
**Coming Soon (TODO)** | ||
|
||
## Deployment | ||
|
||
Deployments will occur automtically with merges into `master`. Merges into master should be limited to specific release branches or hotfixes, as needed. | ||
|
||
- Redesign deployments will need to occur in more wholistic updates. | ||
- Performance or tech debt improvements can occur more individually. |