Noroff Semester Project

Antiquities Auction Website

---

Description:

Welcome to Antiquities. This repository is a multi-page web application built with Vite, Bootstrap, and Sass. It features various routes for authentication, user profiles, post listings, and more using the Noroff API. The project is built using modern JavaScript practices and deployed to Netlify.

Table of Contents

• Prerequisites

• Installation

• Project Scripts

• Deployment

• Dependencies

• Ackowledgements

Prerequisites :

Before you begin, ensure you have the following installed on your system:

• Node.js: v20.11.1 or higher

• npm: v10.9.0 or higher

• git: v2.43.0 or higher

Installation :

Cloning the repo:

git clone https://github.com/aggicreative555/antiquities.git

Installing dependencies:

This project uses several dependencies for development and testing. Here is the list of all dependencies used:

• Vite: Code compiler
• Eslint: Code linting
• Prettier: Code formatting
• Boostrap: Styling
• Sass: Styling

1. Run the following commands to install all dependencies:

npm install

2. After installation, ensure all dependencies are installed properly:

npm list

Project Scripts :

Terminal commands:

1. Run the developement server:

npm run dev

2. Build for production:

npm run build

3. Preview:

npm run preview

4. Run linting checks:

npm run lint

5. Run with prettier

npm run format

Deployment:

This project can be deployed on platforms like Netlify. When deploying to Netlify, ensure you have the following configurations:

• Build command: npm run build
• Publish directory: dist/

Dependencies:

• Bootstrap: A popular CSS framework for building responsive web pages.
• Bootstrap Icons: Boostrap Icons.
• dotenv: A module to load environment variables from .env files.
• @popperjs/core: A library used by Bootstrap for positioning tooltips and popovers.

License:

This project uses an ISC license.

Acknowledgements:

This project is a part of my Noroff University of Technology education.