This project is a full-stack application consisting of a frontend built with Next.js and a backend server.
The frontend is located in the frontend directory and is built using React with TypeScript. It includes:
- Components: Reusable UI components are located in the
componentsdirectory. - Pages: The main entry point for the application is in the
pagesdirectory, including the homepage and custom app component. - Public Assets: Static files such as images and fonts are stored in the
publicdirectory. - Styles: Global CSS styles are defined in the
stylesdirectory. - TypeScript Configuration: The
tsconfig.jsonfile contains TypeScript compiler options. - Package Configuration: The
package.jsonfile lists dependencies and scripts for the frontend.
The backend is located in the backend directory and is responsible for handling server-side logic. It includes:
- App Entry Point: The main server setup is in
src/app.ts. - Type Definitions: Shared types and interfaces are defined in
src/types/index.ts. - Package Configuration: The
package.jsonfile lists dependencies and scripts for the backend. - TypeScript Configuration: The
tsconfig.jsonfile contains TypeScript compiler options.
To get started with the project, clone the repository and install the dependencies for both the frontend and backend:
-
Navigate to the
frontenddirectory and run:npm install npm run dev -
In a separate terminal, navigate to the
backenddirectory and run:npm install npm start
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
This project is licensed under the MIT License.