Vim Web Game

A community-driven Vim gamification learning platform for improving Vim skills.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Diagram
4. Usage
5. Roadmap
6. Contributing
7. Contributing
8. License
9. Contact
10. Acknowledgments

About The Project

Features

Built With

Front-end

• 
• 
• 
• 

API

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these steps.

Requirements

Make sure these programs are installed on your machine.

• Node.js
• Postgresql

Prerequisites

• yarn

  npm install yarn@latest -g

Installation

1. Clone the repo

   git clone https://github.com/mullzalt/vim-web-game.git

2. Setting up server

For the server side installation, refer to this guide here

3. Setting up client

For the client side installation, refer to this guide here

(back to top)

Diagram

See the diagrams here.

(back to top)

Usage

(back to top)

Roadmap

(back to top)

Contributing

(back to top)

License

(back to top)

Contact

(back to top)

Acknowledgments

(back to top)