UniBans

Explore »

Report Bug · Request Feature

About The Project

UniBans aims to be a simple and easy website for university students from all around the world to communincate and help each other. :p

Getting Started

Follow the steps below to get started.

Prerequisites

Before you run the project you will need to install:

• nodejs

• MongoDb

Installation

1. Clone the repo

   git clone https://github.com/1homsi/UniBans.git

2. Install NPM packages

   npm install

3. Run the server

   npm dev

4. Navigate to client floder

   cd client

5. Install NPM packages

   npm install

6. Run the client

   npm dev

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star!

Steps to contribute:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AwsomeFeature)
3. Commit your Changes (git commit -m 'Add some AwsomeFeature')
4. Push to the Branch (git push origin feature/AwsomeFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)