This is a collaborative educational project where we are developing a marketplace for yachts from Norway. The project includes a separate backend system and involves a team consisting of developers, a designer, and a tester. Our goal is to learn and apply various skills while creating a functional and user-friendly platform for yacht buyers and sellers.
The front-end of the project is built using Next.js with TypeScript, Tailwind CSS, Ant Design, and integrates images from AWS S3, while maintaining code quality with Prettier, ESLint, and Husky.
Instructions on how to install the project.
git clone https://github.com/finedefinition/nyc-frontend.git
cd repo
npm installnpm run devThis will open your browser at http://localhost:3000.
To display yacht photos, you need to follow a few simple steps. ⛵
- Create an
.env.localfile in the project's root directory. - Fill this file with the necessary data.
You'll get the required data from the repository owner.
We recommend creating a new branch from the test branch.
Additionally, please create pull requests for your changes.
src/
├── app/ # Main application routing, including routing.
├── components/ # Reusable UI components.
├── context/ # Context API files for managing global state.
├── data/ # Static or mock data used for development.
├── hooks/ # Custom React hooks for encapsulating reusable logic.
├── interfaces/ # TypeScript interfaces and types for type safety across the application.
├── lib/ # Contains configuration for third-party libraries.
├── public/ # Static assets such as images, fonts, and other files served directly.
└── utils/ # Utility functions and helper methods used throughout the application.This project is licensed under the MIT License.
To learn more about Next.js take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.