project-nutella

project-nutella

Apollo GraphQL server for aptiche

View Docs · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Built With
3. Getting Started
   • Prerequisites
   • Installation
   • Contributing
4. License
5. Starware
6. Contributors

About The Project

Project developed and maintained by DSC NIT Rourkela

The backend repository for an online quizzing platform (Apti-Che) to be used by the members of AICHE NIT Rourkela.

Built With

Following technologies are libraries are used for the development of this project.

• Node.js
• Express
• Typescript
• GraphQL
• Apollo-Server
• MongoDB
• Mongoose
• Firebase-Authentication
• Typegoose
• Typegraphql

Getting Started

To setup the project locally follow the steps below

Prerequisites

• Node.js

  # Homebrew
  brew install nodejs
  
  # Sudo apt
  sudo apt install nodejs
  
  # Packman
  pacman -S nodejs
  
  # Module Install
  dnf module install nodejs:<stream> # stream is the version
  
  # Windows (chocolaty)
  cinst nodejs.install
  

• Yarn

  npm install --global yarn

• Git

  # Homebrew
  brew install git

  # Sudo apt
  apt-get install git

  # Packman
  pacman -S git

  # Module Install (Fedora)
  dnf install git

Installation

1. Clone the fork

   git clone https://github.com/<username>/project-nutella.git

2. Install dependencies

   # Please use yarn over npm
   yarn install

3. Start the server locally

   yarn develop

Contributing

Our Slack Community: Slack Invite

Contributions are welcome 🎉🎉 Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your local system
3. Commit changes to your own separate branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

License

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

Starware

dscnitrourkela/project-guava is Starware. This means you're free to use the project, as long as you star its GitHub repository. Your appreciation makes us grow and glow up. ⭐

Contributors ✨

Thanks goes to these wonderful people

Ritesh Patil 💻 🤔 🚧 📆

Abhibhaw Asthana 💻 🚧 🛡️

(emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!