Giter Club home page Giter Club logo

codelabz's Introduction

CodeLabz

CodeLabz is a platform where the users can engage with online tutorials and the organizations can create tutorials for the users. The platform will be developed using ReactJS front end library and the back end will be developed using the Google Cloud Firestore and Google Firebase Real-Time database.

User Guide

How to Setup

Clone the repository.

How to Use

Run npm install in CodeLabz folder.

 cd CodeLabz/
 npm install

First you need to create a .env file in CodeLabz folder following the template provided in the file env.example

  1. Sign in to https://console.firebase.google.com/.
  2. Click Add Project and necessary information about the project.
  3. Agree to the terms and click Create Project.
  4. After creating the project, click Add Firebase to your web app.
  5. Add app nick name and click register app.
  6. Copy the firebase configuration.
  7. Paste the configuration .env file.

You should fill in these values in their relevent fields in the .env file.

To run the project:
$ npm start

NOTE: Before starting the server create a file named .env same as .env.example and add your Firebase Configurations in the file.

Visit localhost:3000 to browse.

How to Deploy Firebase Cloud Functions

NOTE:To Deploy firebase cloud functions you have to satisfy following requirements

  1. Your Firebase project should have Blaze plan or higher version
  2. You should have installed Firebase CLI tool in your machine

Run npm install in CodeLabz/functions folder.

 cd CodeLabz/functions
 npm install

Then you have to generate a private key file for your service account.To get the key file go to this link and follow the instructions https://firebase.google.com/docs/admin/setup#initialize-sdk.

Once you have obtaions the key create folder name as 'private' in this folder 'CodeLabz/functions'.Then copy and paste the key file in private folder. Rename the key file as 'cl-dev-pk.json'

After that change the database url to your project database url in 'CodeLabz/functions/auth.js'

Move to the root directory and open a command prompt and type following commands

 npm run-script build
 firebase login
 firebase projects:list

Find the project ID form the project list that you want to deploy the cloud functions

firebase use <project_id>
firebase deploy

codelabz's People

Contributors

rijusougata13 avatar thisuraseniya avatar piyumaldk avatar niweera avatar hiranthar avatar ffalpha avatar shehand avatar wathsara avatar charithccmc avatar susithrj 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.