Skip to content

Commit

Permalink
* Updates to documentation files.
Browse files Browse the repository at this point in the history
  • Loading branch information
mrbernnz committed Jan 15, 2018
1 parent 7007622 commit 2227893
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 13 deletions.
5 changes: 2 additions & 3 deletions .github/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,5 @@ Provide more context by answering these questions:
### Pull Requests

* Include screenshots and animated GIFs in your pull request whenever possible.
* Follow the [Airbnb React/JSX](https://github.com/airbnb/javascript/tree/master/react) styleguide.
* Include thoughtfully-worded, well-structured
[Jest](https://facebook.github.io/jest/) tests in the `./__tests__` folder. Run them using `npm test`.
* Follow the [Airbnb](https://github.com/airbnb/javascript) styleguide.
* Include thoughtfully-worded, well-structured [Jest](https://facebook.github.io/jest/) tests in the `./__tests__` folder if applicable. Run them using `npm test`.
52 changes: 42 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,49 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE)
# Vets Who Code Serverless Web App
![node](https://img.shields.io/badge/node-v8.9.4-brightgreen.svg?style=flat-square)
![npm](https://img.shields.io/npm/v/npm.svg?style=flat-square)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE)
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-orange.svg?style=flat-square)](https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/contributing.md)

# ![VetsWhoCode](https://avatars1.githubusercontent.com/u/18350560?s=200&v=4 "VWC Logo") Vets Who Code Web App
The Vets Who Code Web App is a Jamstack Applicaton designed more for speed.
By doing this we can focus on creating a beautiful web experience with a focus on telling the story of Vets Who Code.

## Getting Started
These instuctions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

## Prerequisites
You will need the following properly installed on your computer.

* [Git](http://git-scm.com/)
* [Node](http://nodejs.org/) (with NPM)
* [Node](http://nodejs.org/)
* [NVM](https://github.com/creationix/nvm)
* [Gatsby](https://www.gatsbyjs.org/)

The Vets Who Code Web App is a Jamstack Applicaton designed more for speed.
By doing this we can focus on creating a beautiful web experience with a focus on telling the story of Vets Who Code.
## Installing
In a terminal window run these commands.
```sh
$ git clone [email protected]:Vets-Who-Code/vwc-site.git
$ cd vwc-site
$ npm install
$ npm run develop
```

In another terminal window run this command.
```sh
$ npm run build --prefix-path
```

You should be able to view the website locally at `http://localhost:8000/`.

<!-- ## Deployment -->

## Contributing
Please read [contributing](https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/contributing.md) for details on our code of conduct and the process for submitting pull requests.

[CONTRIBUTORS](https://github.com/Vets-Who-Code/vwc-site/graphs/contributors)
## License
This project is licensed under the MIT License - please see [license](https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE) for more details.

<!-- ## Acknowledgements -->

## TODOS
- [ ] Add Podcast page
- [ ] Add Shop page
- [ ] Add Testimonials
- [ ] Start implementing React image slider and countdown calendar
## Roadmap
Please checkout our [roadmap](https://github.com/Vets-Who-Code/vwc-site/blob/update/README/roadmap.md) for details of upcoming features.
5 changes: 5 additions & 0 deletions roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## TODOS
- [ ] Add Podcast page
- [ ] Add Shop page
- [ ] Add Testimonials
- [ ] Start implementing React image slider and countdown calendar

0 comments on commit 2227893

Please sign in to comment.