Table of Contents
Atelier is a desktop and mobile friendly app utilizing React and Express that enables users to browse through a collection of over 15 million products, add them to their outfits, read through a robust Q&A section, peruse the products ratings and reviews, and add products to their cart.
Instructions to setup Project Atelier on your local machine below.
npm install npm@latest -g- Clone the repo
git clone https://github.com/The-Fellowship-of-the-stRing/project-atelier.git
- Install NPM packages
npm install
- Enter your port, API URL, and Github Token in
.envfileGIT_API_URL = (your database URI) GIT_TOKEN = (your github token)
- Run build command.
npm run build
- Run in production environment
npm run server
Atelier is run on the designated port and opens a webpage as soon as the npm run start command is utilized. It can also be accessed utilizing localhost:PORT directly in the browser.
Run tests: npm run test
Run tests with coverage: npm run coverage
- Include displaying of products
- Implementing sorting functions
- Implement modals
- Continue styling with additonal css
- Reduction in Questions and Answers API calls to 1 initial call by presortings answers from API
- Reduced number of API calls made from infinite scrolling by throttling API requests to prevent exceeding limits
- Added compression, code splitting and preload from client server to reduce webpack size and improve performance
Feel free to join in! Whether its fixing bugs, improving documentation, or simply spreading the word!