0.0.4 • Published 10 months ago
bys-container v0.0.4
BYS-CONTAINER 1.0.0
| TAGS | EXPLAIN |
|---|---|
| ADDED | It gives information about newly added Component, package and files. |
| CREATED | It gives information about the Component, package and files created for the first time. |
| CHANGED | It gives information about the changed function or method related to the problem or design. |
| REMOVED | It gives information about the removed function or method related to the problem or design. |
| UPDATED | It gives information about the updated function or method related to the problem or design. |
| FIXED | It gives information about the solution of the problem caused by the problem. |
| TODO | It gives information about the planned and encountered problem in the future. |
| TEST | It is a tag created to test whether the functions added during build or for projects working in separate environments can work synchronously. |
| INFO | It gives information about the information that is not related to the problem or design. |
What is this?
This is a simple container for BYS-CONTAINER. It is a simple container for BYS-CONTAINER.
Getting Started
In this section, the steps to be taken to run the project on your local machine are included.
Installation
- Clone the repo
git clone https://gitlab.com/idvlabs/bys/bys-container.git- Install NPM packages
cd bys-container
npm install- Set .env.development file for development environment
REACT_APP_BASE_SERVICE_URL = YOUR_SERVICE_URL
REACT_APP_ACCESS_TOKEN_KEY = YOUR_ACCESS_TOKEN_KEY- Set .env.production file for production environment
REACT_APP_BASE_SERVICE_URL = YOUR_SERVICE_URL
REACT_APP_ACCESS_TOKEN_KEY = YOUR_ACCESS_TOKEN_KEY- Hot Refresh (Development) React
npm run start:react- Build (Production) with Webpack
npm run build:prodStorybook Usage
In this section, the steps to be taken to run the project on your local machine are included.
İlk olarak yeni eklenen komponentlerin
/storiesdizinine eklenmesi gerekmektedir. Daha sonranpm run storybookkomutu ile çalıştırılabilir. Detaylar için Storybook sitesine bakabilirsiniz. Oluşturulmuş Örnek bir komponent için/stories/Button.stories.tsxdosyasına bakabilirsiniz.
- Storybook
npm run storybookBuilt With
In this section, the technologies used in the construction of the project are included.
- Redux Toolkit
- React Native Maps
- Typescript
- Axios
- React Router Dom
- Material UI
- Storybook
- Tailwind CSS
- React Hook Form
- Zod
- @tanstack/react-table
- JWT Decode
Roadmap
- Redux Toolkit Setup & Configuration.
- Material UI Setup & Configuration.
- React Router Dom Setup & Configuration.
- Axios Setup & Configuration.
- Storybook Setup & Configuration.
- Tailwind CSS Setup & Configuration.
- React Hook Form Setup & Configuration.
- Zod Setup & Configuration.
See the Open Issues for a full list of proposed features (and known issues).
Node & NPM Versions
- minimum node version: 16.0.0
- minimum npm version: 7.0.0
npm i -g npm - minimum typescript version: 4.5.2
npm i -g typescript - minimum eslint version: 7.32.0 (for eslint-config-airbnb-typescript)
npm i -g eslint - minimum prettier version: 2.4.1
npm i -g prettier
VSCODE Extensions
- ESLint (required)
- Prettier (required)
- Tailwind CSS IntelliSense (required)
- Sort Imports (optional)
- Auto Rename Tag (optional)
- Error Lens (optional)
- ES7+ React/Redux/GraphQL/React-Native snippets (optional)
- Github Copilot (optional)