A tool that facilitates the participation of Micro, Small, and Medium businesses (MSMEs) in the Colombian public procurement market.
To download the repo dependencies run
npm install
Copy the .env.example into .env and set the the backend URL with your dev server. As the build system is Vite, the variables name should start with VITE_
For VS Code Intellisense to recognize the new variables declare them in the file vite-env.d.ts
These are the commands available in package.json
Commnad | Description |
---|---|
npm run dev |
Runs dev server with the HMR locally on port 3000 |
npm run lint |
Runs eslint to find errors |
npm run lint-fix |
Runs eslint to find errors and auto-fix the ones it can |
npm run build |
Builds optimized app package in the dist directory |
npm run preview |
Runs server using the dist folder from a build |
npm run test |
Runs tests |
npm run storybook |
Runs a Storybook locally on port 6006 |
npm run build-storybook |
Builds static app with a Storybook's content |
You should configure VSCode to use ESLint and Prettier to find problems and format our code, respectively. If you don't have the extensions installed yet, install them: Prettier - Code formatter and ESLint.
There is a .vscode/settings.json file with the following settings:
{
...
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode"
...
}
to configure VSCode to use Prettier to format our file on save. The ESLint extension should work automatically if there's a valid configuration file in (.eslintrc) the current workspace.
For Tailwind, the official Tailwind CSS IntelliSense extension enhances the Tailwind development experience by providing users with advanced features such as autocomplete, syntax highlighting, and linting.
Husky and Lint-staged are set up to run pre-commit hook and now allow to commit if there is an Eslint error. Also commit-lint is used to check commit messages conventions
Must be one of the following:
- build: Changes that affect the build system or external dependencies
- ci: Changes to our CI configuration files and scripts
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
For translations, the project is using the Transifex service.
The specific implementation being used is: Transifex Native SDK
For specific instructions on how to use the available components, please refer to:
https://www.npmjs.com/package/@transifex/react
It's necessary to use the Transifex CLI in order to push content to the service server.
For detailed instructions on installing the CLI, please refer to:
https://www.npmjs.com/package/@transifex/cli
To upload the current strings to the Transifex server for translation, execute the following command, we must be positioned within the /src directory of the project
npx txjs-cli push --token=[transifex-token] --secret=[transifex-secret]