-
-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
49 additions
and
13 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
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 |
---|---|---|
@@ -1,17 +1,49 @@ | ||
[](https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE) | ||
# Vets Who Code Serverless Web App | ||
 | ||
 | ||
[](https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE) | ||
[](https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/contributing.md) | ||
|
||
#  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. |
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,5 @@ | ||
## TODOS | ||
- [ ] Add Podcast page | ||
- [ ] Add Shop page | ||
- [ ] Add Testimonials | ||
- [ ] Start implementing React image slider and countdown calendar |