Giter Club home page Giter Club logo

vets-who-code-app's Introduction

node npm License: MIT Contributions Welcome Powered by Vercel

VWC Logo

Welcome to Vets Who Code Web App πŸŽ‰

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

Our Mission 🎯

  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.

Getting Started πŸš€

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

Prerequisites πŸ› οΈ

Installation Steps πŸ”§

Fire up your terminal and run:

$ git clone https://github.com/Vets-Who-Code/vets-who-code-app.git
$ cd vets-who-code-app
$ nvm install
$ yarn add
$ npm run dev

And boom! Navigate to http://localhost:3000/ to see the app.

Development using Dev Container (Optional) 🐳

We have a development container to help you quickly set up your dev environment. This is completely optional but can make getting started easier.

Requirements

Steps

  1. Clone the repository

    git clone https://github.com/Vets-Who-Code/vets-who-code-app.git
    cd vets-who-code-app
  2. Open in VS Code

    • Open the root directory in VS Code.
    • A notification will appear asking if you would like to reopen the project in a dev container. Choose "Reopen in Container".
    • If you don't see the notification, open the Command Palette (F1) and run Remote-Containers: Reopen in Container.
  3. Wait for the Build

    • The dev container will build based on the Dockerfile and devcontainer.json configuration. This may take a few minutes the first time.
  4. Start Developing

    • After the container is built, VS Code will attach to it. You're now developing inside the container!

Remember, this is optional. If you prefer to set up your development environment manually, you can continue to do so.

Contributing 🀝

We love contributions! Please read our Contributing Guidelines to get started.

Roadmap πŸ—ΊοΈ

Curious about upcoming features? Check our Roadmap.

License πŸ“œ

This project is under the MIT License - see the License for more details.

vets-who-code-app's People

Contributors

andrew-t-james avatar angelospk avatar axecopfire avatar bhankee avatar bmw2621 avatar cameron-porter avatar captamericajs avatar charley81 avatar dependabot[bot] avatar emma-r-slight avatar gixxerblade avatar ineso1984 avatar ingridfuentes avatar jeromehardaway avatar joneskj55 avatar judyz01 avatar jvsonv avatar kbrandon19 avatar marklocklear avatar meghanduprey avatar mrbernnz avatar nagano564 avatar nbhankes avatar ozzievargas avatar rmrose78 avatar stephanlamoureux avatar takomane avatar tricinel avatar usmcamgrimm avatar viglucci avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.