Merge pull request #152 from RecyThing/develop

prod(v1.0.0): release to production

Author: TaksaWibawa

.eslintrc.cjs

@@ -12,6 +12,7 @@ module.exports = {
   settings: { react: { version: '18.2' } },
   plugins: ['react-refresh'],
   rules: {
+    'react/prop-types': 'off',
     'react-refresh/only-export-components': [
       'warn',
       { allowConstantExport: true },

.gitignore

@@ -22,3 +22,4 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+*.env

README.md

@@ -1,14 +1,78 @@
 # RecyThing - Website (Admin)
 
-### Table of Contents
+![RecyThing](./public/readme-thumbnail.png)
+
+## Table of Contents
 
 - [RecyThing - Website (Admin)](#recything---website-admin)
+
   - [Table of Contents](#table-of-contents)
+  - [Folder Structure](#folder-structure)
+  - [Tech Stack](#tech-stack)
+  - [Contributors](#contributors)
   - [How To Export Your Modules (Re-exporting)](#how-to-export-your-modules-re-exporting)
   - [Naming Conventions](#naming-conventions)
   - [Project Documents](#project-documents)
   - [References](#references)
 
+## Folder Structure
+
+Before diving into the code, it's important to understand the project's folder structure. The structure is organized to enhance readability and maintainability of the code. Here's a high-level overview of the directory layout:
+
+```bash
+src
+├───apis         # Objects and methods for API calls
+├───assets       # Static assets (images, etc.)
+├───components   # Reusable components (buttons, sections, etc.)
+├───configs      # Configuration files (Axios, Chakra UI Theme, etc.)
+├───hooks        # Custom React hooks
+├───layout       # Page layouts
+├───pages        # Feature pages
+├───routes       # Route definitions and routing logic
+├───services     # Services (authentication, etc.)
+├───store        # Redux store and reducers
+├───utils        # Utility functions
+├───App.jsx      # Main App file to render pages and routes
+├───index.css    # Global styles
+└───main.jsx     # Entry point of the app, providers are set up here
+```
+
+## Tech Stack
+
+This project uses the following technologies:
+
+[![Axios](https://img.shields.io/badge/Axios-5A2D9C?style=for-the-badge&logo=axios&logoColor=white)](https://axios-http.com/)
+[![Chakra UI](https://img.shields.io/badge/Chakra%20UI-319795?style=for-the-badge&logo=chakra-ui&logoColor=white)](https://chakra-ui.com/)
+[![Chart.js](https://img.shields.io/badge/Chart.js-FF6384?style=for-the-badge&logo=chartdotjs&logoColor=white)](https://www.chartjs.org/)
+[![CKEditor](https://img.shields.io/badge/CKEditor-%23494E52.svg?style=for-the-badge&logoColor=white)](https://ckeditor.com/)
+[![Framer Motion](https://img.shields.io/badge/Framer%20Motion-0055FF?style=for-the-badge&logo=framer&logoColor=white)](https://www.framer.com/api/motion/)
+[![React Hook Form](https://img.shields.io/badge/React%20Hook%20Form-275EA3?style=for-the-badge&logo=react-hook-form&logoColor=white)](https://react-hook-form.com/)
+[![React Router](https://img.shields.io/badge/React%20Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)](https://reactrouter.com/)
+[![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)](https://reactjs.org/)
+[![Redux Toolkit](https://img.shields.io/badge/Redux%20Toolkit-764ABC?style=for-the-badge&logo=redux&logoColor=white)](https://redux-toolkit.js.org/)
+[![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)
+[![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white)](https://vercel.com/)
+[![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/)
+[![Yup](https://img.shields.io/badge/Yup-EE4C2C?style=for-the-badge&logo=yup&logoColor=white)](https://github.com/jquense/yup)
+
+> For more information about the tech stack, please refer to the [package.json](https://github.com/RecyThing/RecyThing-Web/blob/develop/package.json)
+
+## Contributors
+
+This project wouldn't be possible without the hard work and dedication of our team. Here are the contributors who brought this project to life:
+
+| No  | Name            | Role        | Github Profile Link                                                      |
+| :-- | :-------------- | ----------- | ------------------------------------------------------------------------ |
+| 1.  | Taksa Wibawa    | Team Leader | [https://github.com/TaksaWibawa](https://github.com/TaksaWibawa)         |
+| 2.  | Putri Ramadhani | Member      | [https://github.com/Putri-R](https://github.com/Putri-R)                 |
+| 3.  | Felicio Angga   | Member      | [https://github.com/FelicioAngga](https://github.com/FelicioAngga)       |
+| 4.  | Dady Bima       | Member      | [https://github.com/WorkerHarder171](https://github.com/WorkerHarder171) |
+| 5.  | Leonardy Wijaya | Member      | [https://github.com/Leonardiwijaya](https://github.com/Leonardiwijaya)   |
+| 6.  | Indra Kurniawan | Member      | [https://github.com/indrakurr](https://github.com/indrakurr)             |
+| 7.  | Irfan Maulana   | Member      | [https://github.com/IrfanM66](https://github.com/IrfanM66)               |
+| 8.  | Rivaldo         | Member      | [https://github.com/badebess](https://github.com/badebess)               |
+| 9.  | Naufal Darma    | Member      | [https://github.com/naufalpratam4](https://github.com/naufalpratam4)     |
+
 ## How To Export Your Modules (Re-exporting)
 
 _Why do we need to re-export our modules?_
@@ -28,7 +92,7 @@ _How to re-export our modules?_
    import React from "react";
 
    export function YourButton() {
-   	return <button>Your Button</button>;
+    return <button>Your Button</button>;
    }
    ```
 
@@ -58,7 +122,7 @@ _How to re-export our modules?_
    import { YourButton } from "../components";
 
    export function Page() {
-   	return <YourButton />;
+    return <YourButton />;
    }
    ```
 
@@ -91,5 +155,16 @@ _How to re-export our modules?_
 
 ## References
 
-- [Chakra UI](https://chakra-ui.com/)
-- [Tailwind CSS](https://tailwindcss.com/)
+- [React](https://reactjs.org/): JavaScript library for building user interfaces
+- [Vite](https://vitejs.dev/): Development environment and bundler
+- [Chakra UI](https://chakra-ui.com/): UI component library
+- [Tailwind CSS](https://tailwindcss.com/): Utility-first CSS framework
+- [CKEditor](https://ckeditor.com/): Rich text editor
+- [Redux Toolkit](https://redux-toolkit.js.org/): Global state management
+- [React Router](https://reactrouter.com/): Declarative routing for React
+- [React Hook Form](https://react-hook-form.com/): Efficient, flexible, and extensible forms
+- [Yup](https://github.com/jquense/yup): Form validation
+- [Axios](https://axios-http.com/): Promise-based HTTP client
+- [Chart.js](https://www.chartjs.org/): Simple yet flexible JavaScript charting
+- [Framer Motion](https://www.framer.com/api/motion/): Animation library for React
+- [Vercel](https://vercel.com/): Deployment platform

index.html

@@ -2,9 +2,9 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <link rel="icon" type="image/svg+xml" href="/logo.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + React</title>
+    <title>RecyThing Web</title>
   </head>
   <body>
     <div id="root"></div>

jsconfig.json

@@ -1,5 +1,6 @@
 {
 	"compilerOptions": {
+    "jsx": "react",
 		"baseUrl": ".",
 		"paths": {
 			"@/*": ["src/*"]

netlify.toml

@@ -0,0 +1,4 @@
+[[redirects]]
+from = "/*"
+to = "/index.html"
+status = 200