Skip to content

Latest commit

 

History

History
260 lines (202 loc) · 8.32 KB

README.md

File metadata and controls

260 lines (202 loc) · 8.32 KB
Raw


uCritique Reviews

An Application for watch over best services.
Explore the docs »

View Demo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Acknowledgments

About The Project

The project is mainly for learning purposes. uCritque review is an application that will help people to understand more about the good services all over the world.

Features

  • An application for personal service review.
  • To see the review user don't need any account.
  • User can add their own opinion by creating an account.
  • Only logged in user can acces the full website.
  • Guest user can only visit the website.
  • Also logged in user can see their own revies at a glance.
  • A dedicated blog section is to know updated technology.
  • Dynamic title will show the dynamic route of the navigations.
  • Authenticated user can create service and reviews.
  • Data is secured with JWT token.
  • Anyone can not get access easily dure to JWT token authorization.
  • 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
  • Material Tailwind
  • Mamba UI
  • REACT ROUTER

Packages, library other technology used

  • React-hook-form
  • React-icons
  • React-Helmet
  • React-loader
  • React-photo-view
  • JWT token
  • Firebase Authentication
  • Vercel
  • GitHub authentication
  • Google authentiacation

(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 onlince e-commerce 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

(back to top)