Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme #515

Merged
merged 1 commit into from
Aug 31, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 49 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,60 @@
<p align=center>
<img src=https://img.shields.io/badge/node-v10.16.0-brightgreen.svg?style=flat-square alt="node" />
<img src=https://img.shields.io/badge/npm-v5.6.0-blue.svg?style=flat-square alt="npm" />
<a href=https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE>
<img src=https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square alt="License: MIT" />

<p align="center">
<img src="https://img.shields.io/badge/node-v10.16.0-brightgreen.svg?style=flat-square" alt="node" />
<img src="https://img.shields.io/badge/npm-v5.6.0-blue.svg?style=flat-square" alt="npm" />
<a href="https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square" alt="License: MIT" />
</a>
<a href=https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/contributing.md>
<img src=https://img.shields.io/badge/contributions-welcome-orange.svg?style=flat-square alt="Contributions Welcome" />
<a href="https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/contributing.md">
<img src="https://img.shields.io/badge/contributions-welcome-orange.svg?style=flat-square" alt="Contributions Welcome" />
</a>
<a href=https://vercel.com?utm_source=vetswhocode.io&utm_campaign=oss>
<img src=https://img.shields.io/badge/Powered_by-Vercel-black?style=flat-square alt="Powered by Vercel">
<a href="https://vercel.com?utm_source=vetswhocode.io&utm_campaign=oss">
<img src="https://img.shields.io/badge/Powered_by-Vercel-black?style=flat-square" alt="Powered by Vercel">
</a>
</p>

<p align=center>
<img src=https://avatars1.githubusercontent.com/u/18350560?s=200&v=4 alt="VWC Logo" />
<p align="center">
<img src="https://avatars1.githubusercontent.com/u/18350560?s=200&v=4" alt="VWC Logo" />
</p>

# Vets Who Code Web App
# Welcome to Vets Who Code Web App :tada:

Hey there, Soldier! Welcome to the **Vets Who Code Web App**. This project serves as a communal code base where military vets and their spouses can sharpen their coding skills. 🚀

## What's Under The Hood 🧰

This app is built using a jam-packed tech stack including:

- Tailwind
- Next.js
- Playwright
- Typescript
- MDX
- Lerna architecture

The Vets Who Code Web App is a multifaceted application built using Tailwind, Next.js, Playwright, Typescript, MDX, and the Lerna architecture. The purpose of this app is threefold: Firstly, to create a production-grade product that benefits all veterans and military spouses; secondly, to enable the continuous addition of new features that all veterans can utilize; and thirdly, to serve as an open-source app where our troops can learn how to write code. By actively working on this app, pulling tickets, and making changes as needed, our troops can gain practical experience, contributing to a professional, fast, and serverless product designed with their needs in mind.
### Our Mission :dart:

## Getting Started
1. **Empower Veterans and Military Spouses**: We're creating a production-grade app that addresses the unique needs of our community.

2. **Ever-Evolving Platform**: New features are continuously added to provide valuable tools for our users.

3. **Learn By Doing**: The project serves as a hands-on experience for our community to learn and grow their coding skills.

These instructions 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.
## Getting Started 🚀

### Prerequisites
To get a local copy up and running, you'll need a few things installed on your machine.

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

- [Git](http://git-scm.com/)
- [Node](http://nodejs.org/)
- [NVM](https://github.com/creationix/nvm)
- [Yarn](https://yarnpkg.com/)
- [NextJS](https://nextjs.org/)
- [Git](http://git-scm.com/)
- [Node](http://nodejs.org/)
- [NVM](https://github.com/creationix/nvm)
- [Yarn](https://yarnpkg.com/)
- [NextJS](https://nextjs.org/)

## Installing
### Installation Steps :wrench:

In a terminal window run these commands.
Fire up your terminal and run:

```sh
$ git clone https://github.com/Vets-Who-Code/vets-who-code-app.git
Expand All @@ -47,26 +64,16 @@ $ yarn add
$ npm run dev
```

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

### Add necessary api keys to your new `.env` file.

<!-- ## Tests -->

<!-- ## 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 issues and/or pull requests.
And boom! Navigate to `http://localhost:3000/` to see the app.

[CONTRIBUTORS](https://github.com/Vets-Who-Code/vwc-site/graphs/contributors)
## Contributing :handshake:

## License
We love contributions! Please read our [Contributing Guidelines](https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/contributing.md) to get started.

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.
## Roadmap 🗺️

<!-- ## Acknowledgements -->
Curious about upcoming features? Check our [Roadmap](https://github.com/orgs/Vets-Who-Code/projects/48/views/2).

## Roadmap
## License :scroll:

Please checkout our [roadmap](https://github.com/orgs/Vets-Who-Code/projects/48/views/2) for details of upcoming features.
This project is under the MIT License - see the [License](https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE) for more details.