/truffle-ai-frontend

Helping VC analysts find early stage tech companies by collecting traces founders leave on the internet

Primary LanguageTypeScript

Truffle AI Frontend

Truffle AI is a tool helping VC analysts find early stage tech companies by collecting traces founders leave on the internet. This repository contains the frontend application for it, which was built using Next.js.

Setup

npm install # installs necessary packages
npm run prepare # installs precommit hook that runs eslint & prettier
npm run dev # starts dev server

Open http://localhost:3000 in your browser to see the result.

Please have a look at the coding guidelines for this project before starting to code.

Recommended extensions

NPM scripts

dev

Starts the application in development mode (with hot-code reloading, error reporting, etc.).

build

Compiles the application for production deployment.

start

Starts the application in production mode. Run build to compile it first.

codegen

Automatically generates types and hooks for new GraphQL queries you create.

lint

Analyzes the code in the src/ folder and gives a list of all problems (errors and warnings).

lint:debug

Same as lint but provides additional information for debugging.

lint:fix

Same as lint but automatically fixes problems that can be solved easily.

prepare

Installs a precommit hook that runs eslint & prettier before every commit.

prettier:check

Analyzes all files in the root directory (and its subfolders) and gives a list of formatting issues that don't follow the rules described in the prettier configuration.

prettier:all

Same as prettier:check but automatically fixes problems.

react:update-react-imports

Removes redundant import statements of react in components.

Environment Variables

Create .env.local in the root directory with the variables given in .env.local.example

Learn more

To learn more about Next.js, take a look at the following resources: