Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 1.5 KB

README.md

File metadata and controls

70 lines (43 loc) · 1.5 KB
Raw

Harvard Museum Catalog

Overview

This project is a web application for interacting with the Harvard Art Museums' collection, using the Harvard Art Museums API. Built with Next.js, Typescript, and React Query, its primary features include browsing the catalog, searching, applying filters, and viewing individual item details.

❗Current Status

The project is in progress. Key functionalities like catalog browsing, search, and filters are operational. Users can also explore details of specific items.

Following steps

  • Enhance UI
  • Fix SSR
  • Use i18n
  • Write tests

How to Set Up the Project

To get the project running locally:

  1. Clone the Repository
git clone https://github.com/ivan-kalachikov/harvard-art.git
cd harvard-museum-catalog
  1. Install Dependencies
npm install

  1. Set Up Environment Create a .env file with the necessary API keys and configurations.

  2. Run in Development Mode

npm run dev

This will start the app on localhost:3000.

Build for Production

npm run build

Prepares the application for deployment.

  1. Start Production Server
npm start

Contributing

Contributions are welcome. Feel free to suggest new features, bug fixes, or improvements in documentation.

License

This project is licensed under the MIT License.

Acknowledgements

Special thanks to The Harvard Art Museums for providing access to their collections via their API.