/kiln-it

🏺 Keep records of my clay creations, shrinkage rate, experiments and status. A viewing platform for friends and whānau to see a catalog or creations too. 📱*Website for mobile view only currently*📱

Primary LanguageJavaScript

Node.js Lint and Test Deploy issues Last Modified

🏺 kiln it

A project that will allow me to keep records of my clay creations. Including type of creation, percent shrinkage the status of firing. A platform for friends and whānau to be able to see a catalog of all the creations I've made and the process they went through.

Using fullstack technologies I have learned and mentor others in, as well as being a project to try out new tech in more complex scenarios.

🚀 Currently deployed version

Used for this project:
GitHub Actions Heroku React React Router Redux Webpack JS Express MUI Sqlite3 Jest Insomnia EsLint Brave Figma UnSplash

Table of Contents

⇣ Installation

Run the following commands in your terminal

npm install
npm run db
cp .env.example .env
npm run dev

The site should then be available on http://localhost:3000

🎨 Design

Figma Design an attempt

🗂 Project Doumentation

ERD

👤 User Stories

MVP

As an admin user:

  • I want to view a creation status log
  • I want to view a creation and all it's details
  • I want to view all my creations
  • I want to update the status of a creation
  • I want to edit a creation
  • I want to add a new creation
  • I want to add a note to a creation
  • I want to add a new clay type
  • I want to add a new creation shape
  • I want to add a new glaze

As a friendly user:

  • I want to view all the creations
  • I want to view a creation and all it's details
  • I want to click a link to take me to instagram to purchase the item

Views

name user purpose
Sign In * View for user to enter their login credentials
Register * View for user to sign up
Home * View list of clay creations
Creation Details * View an existing creation, and when Admin all it's recorded details
Creation Log Admin View list of clay creations and their current status
Add/Edit Creation Admin Create new or edit an existing entry

🪪 License

MIT License

✅ Tests

Run tests with:

npm run test