profile.rocks frontend application

Built with Next.js and deployed as a static site.

Note

This repository does not contain any secrets or sensitive information about the backend services.

Features

• React compiler enabled
• Output static export
• ESlint & Prettier configured
• Sass & SCSS support
• TypeScript (checks JavaScript files too)

Getting Started

1. Installation

Clone the repository and install dependencies using your preferred package manager.

# Using npm
npm install

# Using Yarn
yarn install

# Using pnpm
pnpm install

# Using Bun
bun install

2. Configuration

Create a .env file in the root of the project.

# .env
NEXT_PUBLIC_API="http://localhost:4000"

NEXT_PUBLIC_HREF_HELP="https://www.profile.rocks/i/help"
NEXT_PUBLIC_HREF_PRIVACY="https://www.profile.rocks/i/privacy"
NEXT_PUBLIC_HREF_TERMS="https://www.profile.rocks/i/terms"

NEXT_PUBLIC_PLATFORM_NAME="profile.rocks"
NEXT_PUBLIC_PLATFORM_DESCRIPTION="Design the Map of Your Online Presence"

NEXT_PUBLIC_SITE="https://app.profile.rocks"

See sample.env.

3. Running the Frontend Server

You can run the frontend server in development mode.

# Using npm
npm run dev

# Using Yarn
yarn run dev

# Using pnpm
pnpm run dev

# Using Bun
bun run dev

Check the package.json "scripts" field for other built-in scripts (build, lint, format...).

License

This project is licensed under the MIT License.

See ICON-LICENSES.md for icon licenses.

You can find other profile.rocks open source projects at https://github.com/profilerocks.