Git Product home page Git Product logo

nscc-backend's People

Contributors

aachal01 avatar jhasuraj01 avatar karteekati avatar mergify[bot] avatar omkar76 avatar pranavmasekar avatar the-amazing-atharva avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar

Forkers

aachal01 karteekati the-amazing-atharva omkar76

nscc-backend's Issues

Where to put documentation section [discussion]

This issue is to discuss the best location for the documentation section of our project. Currently, there are several options to consider:

  1. Github Readme: This is the most common location for documentation, as it is easily accessible and visible to users visiting the repository.
  2. Github Wiki: This is another option for documentation, which allows for more detailed and organized information.
  3. A separate documentation website, such as Docusaurus: This option allows for more advanced formatting and organization, but may require more work to set up and maintain.

Any other suggestions?

Please share your thoughts and preferences on where the documentation section should be placed, and any pros and cons of each option. Thanks!

Web Dev Hackathon API

  • Create or update submission
  • Get Submissions by Id
  • Get all submissions
  • upvote submission

Registration API

Require Authorization token for all three below endpoints

Get All the fields required for events registrations
https://asia-south1-nsccpccoe.cloudfunctions.net/register/:eventId/fields

export interface TextField {
  type: "text"
  name: string
  label: string
  placeholder: string
  value: string
  mutable: boolean
  regex: string
}
export interface SelectField {
  type: "options"
  name: string
  label: string
  options: (string | number)[]
  value: string
  mutable: boolean
}

export type Field = SelectField | TextField
{
  "isError": false,
  "data": {
    "eventId": "codehive",
    "fields": [
      {
        "type": "text",
        "name": "displayName",
        "label": "Enter Name",
        "placeholder": "Firstname Lastname",
        "value": "Peach Mountain",
        "mutable": true,
        "regex": ".+"
      },
      {
        "type": "options",
        "name": "gender",
        "label": "Gender",
        "value": "",
        "mutable": true,
        "options": [
          "Male",
          "Female"
        ]
      },
      {
        "type": "options",
        "name": "graduationYear",
        "label": "Graduation Year",
        "value": "",
        "mutable": true,
        "options": [
          2023,
          2024,
          2025,
          2026
        ]
      },
      {
        "type": "text",
        "name": "phoneNumber",
        "label": "Phone Number",
        "placeholder": "+91987654321",
        "value": "",
        "mutable": true,
        "regex": ".+"
      }
    ]
  }
}

Get Registration Status
https://asia-south1-nsccpccoe.cloudfunctions.net/register/:eventId/status

{
  "isError": false,
  "data": {
    "eventId": "eventId",
    "registered": true
  }
}

Post Register for Event
https://asia-south1-nsccpccoe.cloudfunctions.net/register/:eventId

Post Body:

{
  "displayName": "My Name",
  "hackerrank": "My Hackerrank link"
}

Response:

{
  "isError": false,
  "data": {
    "eventId": "eventId",
    "registered": true
  }
}

Account API

  • Update Profile (Name, Branch, Year, PRN No, Coding profiles, Resume link)
  • Get Profile (Name, Branch, Year, PRN No, Coding profiles, Resume link)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.