From 2227893c7b0b75359cb2ee32cfd5b517ad8830a3 Mon Sep 17 00:00:00 2001 From: mrbernnz Date: Mon, 15 Jan 2018 10:30:13 -0500 Subject: [PATCH] * Updates to documentation files. --- .github/contributing.md | 5 ++-- README.md | 52 +++++++++++++++++++++++++++++++++-------- roadmap.md | 5 ++++ 3 files changed, 49 insertions(+), 13 deletions(-) create mode 100644 roadmap.md diff --git a/.github/contributing.md b/.github/contributing.md index 78ca22c01..37670441d 100755 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -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`. diff --git a/README.md b/README.md index 8e7482e59..7ab4296ac 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com: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/`. + + + +## 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. + + -## 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. diff --git a/roadmap.md b/roadmap.md new file mode 100644 index 000000000..638781b49 --- /dev/null +++ b/roadmap.md @@ -0,0 +1,5 @@ +## TODOS +- [ ] Add Podcast page +- [ ] Add Shop page +- [ ] Add Testimonials +- [ ] Start implementing React image slider and countdown calendar