Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 2.51 KB

README.md

File metadata and controls

75 lines (53 loc) · 2.51 KB
Raw

Share Storia Documentation

Introduction

Built with React, NextJS, TypeScript and Tailwind CSS.

Requirements

  • node(18.11.11 or later)
  • yarn(version 1)

Tech We Have Used

Tech specification for this template is given below

Step 1 : Configure your env file

Within the project directory you'll find a .env.example file just rename it as .env.local.

** NOTE : ** This file contain env values for local development but when you wanna use this template for your needs you need to replace this value with your own real API endpoint.

** NOTE : ** To get the map in development mode, go to your .env.local file and put your google map api key there like NEXT_PUBLIC_GOOGLE_API_KEY= put your api key




Step 2 : Running the project

Run below command for getting started with this template.

# on tripfinder or in root directory
$ yarn

$ yarn dev
# which will running the boat template for development

If you want to test your production build in local environment then run the below commands.

# build for production
yarn build

#start template in production mode
yarn start

Folder Structure & Customization

  • To setup you site's basic information like [Logo,Site title,Description etc] go to -> boat/src/app/layout.tsx file
  • To customize tailwind configuration go to -> tailwind.config.js file .
  • /public: This folder contains all the static data used in this project.
  • /src/app: This folder contains all the pages and layouts.
  • /src/components: This folder contains all the template related ui components.
  • /src/components/ui: This folder contains all the common sections related components.
  • /src/contexts: This folder contains all necessary context for this template . Like modal, drawer, gallery etc.
  • /src/styles: Overwrites some third party packages CSS files and our custom CSS in the global.css file.
  • /src/hooks : This folder contains hooks etc.
  • /src/config : This folder contains routes, api-endpoints, constants etc.
  • /src/pages : This folder contains 404.tsx file for not found or unmatching routes.
  • /src/types : This folder contains common used types arround this project.

Update Plan

  • Advanced Settings
    • Enable to add your friends to your story
    • Enable you to pick what you want to be
    • Enable you to choose keywords for your story

share_storia