Code Crate

An Application for qulaified education.
Explore the docs »

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Acknowledgments

About The Project

The project is build based on educational purposes. In this era of digital world everything is centered in the binary digits. So education is also now became more available and quilified through these binary numbers. Now a days anyone can get a quilified proper education from a reputed wise person from anywhere in the world. This application also can take part of these great revolution.

Features

• Any user can visit the website as guest.
• To purchace any course user must have an account.
• Account can be created in three ways GitHub, Google and Email.
• Only logged in user can acces the full website.
• Guest user can download the details as pdf also.
• User can choose and purchase course on demand.
• A dedicated blog section is to know updated technology.
• User can view location of the office on live map.
• User can update profile any time including password.
• Authentication is get by using firebase.
• Also own build server is running for data.
• Further common questions can be found in frequently ask questions section.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• REACT
• TAILWIND CSS
• DAISY UI
• MERAKI UI
• REACT ROUTER

Packages, library other technology used

• React-hook-form
• React-icons
• React-leaflet
• React-loader
• React-to-pdf
• daisy UI
• Firebase Authentication
• Vercel
• GitHub
• Facebook

(back to top)

Getting Started

To run this project locally you need to first install it. Then run it. You can use yarn npm whatever you want.

Prerequisites

Before get into run the project first make sure you have:

• javascript enabled browser
• node js

  download and install from the website

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/dabasishDasJoy/code-crate.git

2. Install NPM packages

   npm install

   or

   yarn install

3. Enter your API in firebase.config.init.js

   const API_KEY = "ENTER YOUR API";

   or

API Reference

Get all courses

  GET https://code-crate-server.vercel.app/courses

Parameter	Type	Description
none	=	Fetch all the topics of the application

Get a specific course

  GET https://code-crate-server.vercel.app/course/${courseId}

Parameter	Type	Description
id	string	Required. Id of course to fetch

Deploy

1.    yarn start

   or

   npm start

   (back to top)

Usage

• This project can be used in online learning or e-learning platform.
• Since the project is most of the dynamic so anyone can user their own data.
• Also there is a dedicated blog section which will help to get updated with modern technolody.
• Also map is used to find the location easily.

(back to top)

Roadmap

• Create react app
• Routing by react rouder dom
• For design used tailwind and daisy ui component library
• React-form-hook to control form data.
• Different packages used to built the website like react-to-pdf to download pdf.
• Built API for fetching data and display dynamically.
  • Used express js for building API
  • Nodemon to run the server
  • Vercel to deploy the server
• Firebase for authenticate user.
• Make user login or register.
• Halt unauthenticated user to private routes.
• Used three types of authentication system GitHub, Google, and Email.
• Deploy the website in firebase.

(back to top)

(back to top)

(back to top)

Website Link

Website Link: https://code-crate.web.app/

(back to top)

Acknowledgments

The resourses helped me out to built this website

• React Router DOM
• React JS

(back to top)