Student Welfare Division, BITS Pilani, Goa
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
public
src
test
tools
vagrant_support
.editorconfig
.flowconfig
.gitattributes
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
Dockerfile
LICENSE.txt
README.md
Vagrantfile
package.json
playbook.yml
yarn.lock

README.md

Web Application for SWD BITS Goa

Build Status Codacy Badge Code Climate Coverage Status Known Vulnerabilities

The main repository for the development of SWD web application of BITS Goa.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Installing

  • Fork the repository.
  • Clone the repository.
git clone https://github.com/username/swd.git 
  • Move into the cloned repo and start the VM.
cd swd
vagrant up
  • Ssh into the VM.
vagrant ssh
  • Start the server. (make sure you are in /home/vagrant/swd/ folder)
yarn start

NOTE: If you encounter this error: throw new Error('Please install sqlite3 package manually');, install it using npm install sqlite3. This is an unwanted dependency, and will be weeded out in future.

Running the tests

yarn test

Runs the test script defined by the package.

And coding style tests

yarn lint

What is "linting"? Linting is the process of checking the source code for Programmatic as well as Stylistic errors. This is most helpful in identifying some common and uncommon mistakes that are made during coding.

Built With

  • Node.js - Node.js is a JavaScript server framework.
  • Express - Node.js web application framework.
  • React - A JavaScript library for building user interfaces
  • GraphQL - A query language for your API.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details


Made with ♥ by OSDLabs