Skip to content

πŸ“šπŸš€ Open Source REST API for creating a community for your college and classroom notes sharing

License

Notifications You must be signed in to change notification settings

piyush97/Slika-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Slika REST API

Gitter chat License: MIT

Open Source REST API for launching an App|| Website for Educational Purpose and Making a community out of it!


Made by the creators of My College Forums

Docs


API Server and Base URL

The API is Hosted on Heroku Right now.


Features:

  1. Create a new student user/Teacher user
  2. Login
  3. Open Profile Page of each User
  4. Open Notes
  5. Chat with other users

Usage

Example Response

curl -s slika.herokuapp.com
{
    "notes": [
        {
            "_id": "5b796fdde7179a69ea61440c",
            "Department": "CV",
            "Subject": "Design of Pre Stressed Concrete",
            "Sem": 7,
            "Link": "https://bit.ly/2MQe38w",
            "id": 1
        }
    ]
}

Tech Used:

  1. NodeJS: 10.6.0,
  2. MongoDb: 3.6.3,
  3. bcryptjs: 2.4.3,
  4. body-parser: 1.18.3,
  5. esdoc: 1.1.0,
  6. esdoc-standard-plugin: 1.0.0,
  7. express: 4.16.3,
  8. gravatar: 1.6.0,
  9. joi: 13.6.0,
  10. jsonwebtoken: 8.3.0,
  11. mongoose: 5.2.9,
  12. mustache-express: 1.2.7,
  13. nodemon: 1.18.3,
  14. passport: 0.4.0,
  15. passport-jwt: 4.0.0,
  16. underscore: 1.9.1,
  17. validator: 10.6.0
  18. chai: 4.2.0,
  19. chai-http: 4.2.0,
  20. mocha: 5.2.0
  21. nyc: 13.0.1

FAQS


What Is Slika?

Slika is an Organisation for Engineers made by Engineers

Why Use Slika-API?

Slika Api not only provides you with the best notes, it also gives you authentications and userbase option to contact other students easily

Future Features

  1. Chat with your teachers
  2. Raise up doubts and queries

Contributions

See the contribution guide for detailed steps

How's the code?

This only works well by accident and was mostly a joke. The code quality is accordingly.

License

This project is provided for educational purposes only. It is not affiliated with and has not been approved by MSRIT or any other Organisation.

MIT License

Copyright (c) 2018 Piyush Mehta

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

License

FOSSA Status

Coming soon

GraphQL Slika-API

IMG_3630

Apps Made using Slika-API

Slika: MSRIT

Screen_Shot_2018_08_21_at_10_51_43_AM

Slika: Hostel

mcf

OFFICIAL API-DOCS

Coming Soon!

Made with πŸ’™ By Piyush Mehta