pappyJ / AGM

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

🚀 Quick start

AGM Concepts Project

AGM Concepts Project

A AGM Concepts - An Event Plannng Business Organisation

Prerequisites

To run this project locally, the follow tools need to be installed:

Installation

Clone the project:

git clone https://github.com/pappyJ/AGM.git

Move into the project directory and install it's dependencies:

cd AGM/
npm install

To start the dev API server run the following command:

npm start

For Rapid Developement Use An Api Client eg:

Postman

Todo:Api Documentation

Open the source code and start editing!

Your site is now running at http://localhost:3000/!

Open the AGM directory in your code editor of choice and edit files under src. Save your changes and the browser will update in real time!

For working on the repository, you'll have to follow these steps:

1: Fork the repo

2: Create a new branch on the forked repository. The name of the new branch should be issue-<ISSUE NO>.

3: Clone the repository on your system.

4: Work on the new branch and push the code.

5: Create a PR.

About

License:MIT License


Languages

Language:TypeScript 94.8%Language:Pug 5.0%Language:Shell 0.2%