Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Latest commit

 

History

History
115 lines (74 loc) · 2.95 KB

README.md

File metadata and controls

115 lines (74 loc) · 2.95 KB
Raw

Site

A web application built with Next.js, integrating Notion for seamless content management.

Overview

This project is a robust web application utilizing Next.js and Notion, designed to enhance user experience and streamline content handling. It combines the latest web technologies to provide both static and dynamic content generation.

Key Features

  • Next.js: Supports both static and server-rendered pages.
  • Notion Integration: Efficient data management through Notion.
  • Responsive Design: Styled with Tailwind CSS for mobile-first usability.
  • TypeScript: Enhances developer experience with static typing.
  • Code Quality Tools: Includes ESLint and Prettier for consistent code quality.

Prerequisites

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/tuanductran/site.git
cd site

  2. Install the dependencies:

    pnpm install

  3. Create a .env file from the example:

    cp .env.example .env

  4. Populate the .env file with the necessary environment variables:

    • NOTION_DATABASE_ID: Your Notion database ID.
    • ARTICLES_DATABASE_ID: Database ID for articles.
    • BOOKS_DATABASE_ID: Database ID for books.
    • CV_NOTION_TOKEN: Token for accessing CV database.
    • CV_NOTION_DATABASE_ID: Database ID for CV entries.
    • NOTION_TOKEN: Token for Notion API access.
    • POSTGRES_URL: URL for connecting to your PostgreSQL database.

Creating a Notion API Integration

  1. Go to Notion Integrations:

  2. Create a New Integration:

    • Click on "New Integration" and fill in the details.
    • Copy the generated Integration Token.

  3. Share Database with Integration:

    • Open your Notion database, click "Share," and invite your integration.

  4. Retrieve Database IDs:

    • Open the database in Notion and check the URL. The database ID is the part of the URL after notion.so/ and before the question mark, if present.

Scripts

  • Development: Launch the development server:

    pnpm dev

  • Build: Prepare the application for production:

    pnpm build

  • Start: Run the production server:

    pnpm start

  • Lint: Run ESLint to check for code issues:

    pnpm lint

  • Fix Lint Issues: Automatically resolve linting problems:

    pnpm lint:fix

  • Type Checking: Execute TypeScript type checks:

    pnpm typecheck

Contributing

We welcome contributions! Feel free to open issues or submit pull requests for new features or bug fixes.

License

This project is licensed under the MIT License. For more details, see the LICENSE file.