Giter VIP home page Giter VIP logo

island_server's Introduction

island_server

The Parse Server instance for Island.

Parse Server Intro

Parse Server is a backend platform written in Node that can be deployed anywhere and includes out of the box support for common things like object storage, push notifications, basic authentication, file storage, etc. It's backed by MongoDB and you can use a variety of solutions for large file storage.

Deploying Locally

  • git clone this repository and run npm install.
  • Install MongoDB.
  • Ensure that there's a MongoDB instance running on your computer (Windows and macOS). You'll need to do this every time you want to run this server locally, or else it won't be able to connect to the database and it won't start. If you want, use MongoDB Atlas or some other MongoDB service to create a hosted Mongo instance and then set the DATABASE_URI config to the URL for it.
  • npm start. You'll see that the script will print out a bunch of errors and then abort. You're missing some config variables. To fix this, create a new file in the root of the project called .env, and add the config variables the script says to add. Some are optional and the log statements are just warnings. Others are required. All config variables can be added to your .env in the format KEY="VALUE".

NPM Scripts

  • npm start: Compiles the TypeScript and starts the server. Do not use node dist/index.js to start the server. Use this instead.
  • npm run clean: Deletes the dist directory to make sure that the next run uses freshly compiled code.

Cloud Functions

Read the Cloud Functions sections of the guides (Android and iOS) to learn how to call Cloud Functions from the client SDKs. We use Cloud Functions to do privileged things that we can't trust client apps to do. The following Cloud Functions are implemented:

  • requestVerificationCode: Used to request that an auth code be sent to a certain phone number via SMS. To call this function, you need to provide phoneNumber and region keys in the JSON body of your API request. The phone number should be sent as the user typed it in, and the region should be one of the valid regions supported by libphonenumber (You want the Alpha-2 column).
  • completePhoneVerification: Used to verify an auth code requested with requestVerificationCode. To call this function, you need to provide phoneNumber and region keys as you do with requestVerificationCode, but you also need to provide a verificationCode key containing the verification code the user typed in. The phoneNumber you provide will be used to find the code. If verification is successful, a session token will be returned. To finish logging in, you should become the user associated with that session token (Android and iOS).

island_server's People

Contributors

pranjalsatija avatar

Watchers

James Cloos avatar  avatar

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.