Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creator79/buckmint
Its is a frontend BUCKMINT React Assignment
https://github.com/creator79/buckmint
react tailwindcss typescript
Last synced: 10 days ago
JSON representation
Its is a frontend BUCKMINT React Assignment
- Host: GitHub
- URL: https://github.com/creator79/buckmint
- Owner: creator79
- Created: 2024-03-08T11:36:50.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-08T11:51:29.000Z (11 months ago)
- Last Synced: 2024-11-15T22:40:49.694Z (2 months ago)
- Topics: react, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://buckmint-1xar.vercel.app/
- Size: 1.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## BUCKMINT React Assignment
Created By with ❤️ from [Vivek Upadhyay](https://)
## Description
- This React application is built using [Vite](https://vitejs.dev/).
- It uses [Tailwind CSS](https://tailwindcss.com/)
- The application is created in [TypeScript](https://www.typescriptlang.org/).
## Pre-requisites
- [git](https://git-scm.com/) - v2.13 or greater
- [NodeJS](https://nodejs.org/en/) - v16 or greater
- [npm](https://www.npmjs.com/) - v6 or greater
## Running in dev environment
1. `cd YOUR_APPLICATION`
2. `npm install`
3. `npm start`
## .env file
This file contains various environment variables that you can configure.
## Folder Structure
```
.
├── package.json
├── postcss.config.js
├── vite.config.js
├── index.html
├── public
│ ├── assets
│ │ ├── images --------- All Project Images
│ │ └── fonts ---------- Project fonts
│ ├── favicon.ico
│ ├── manifest.json
│ └── robots.txt
├── README.md
├── src
│ ├── App.tsx
│ ├── components --------- UI and Detected Common Components
│ ├── constants ---------- Project constants
│ ├── hooks -------------- Helpful Hooks
│ ├── index.tsx
│ ├── pages -------------- All route pages
│ ├── Routes.tsx ---------- Routing
│ ├── styles
│ │ ├── index.css ------ Other Global Styles
│ │ └── tailwind.css --- Default Tailwind modules
│ └── util
│ └── index.tsx ------- Helpful utils
└── tailwind.config.js ----- Entire theme config, colors, fonts etc.
```
For the project to build, **these files must exist with exact filenames**:
- `index.html` is the page template;
- `src/index.tsx` is the TypeScript entry point.
You may create subdirectories inside src.
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
### `npm test`
Launches the test runner in the interactive watch mode.
### `npm run build`
Builds the app for production to the `build` folder.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time.
## Installing a Dependency
You can install any dependencies (for example, React Router) with `npm`:
```sh
npm install
```
```sh
npm install --save react-router
```
Alternatively you may use `yarn`:
```sh
yarn add react-router
```
## License
MIT License
Copyright (c) 2024 Vivek Upadhyay