lcsmelo-0 / face-company

Face company

https://face-company-98y31c3iv-lucasmelo18.vercel.app/ Production Version

Technologies

Summary

1. Alias

2. First Steps

3. Running Project

4. Using a alias

5. Building for production

6. API Reference

Alias

We have the following aliases configured in webpack:

• app-actions - Reference to redux/_actions folder
• app-components - Reference to components folder
• app-consts - Reference to consts folder
• app-hooks - Reference to hooks folder
• app-images - Reference to public/images folder
• app-models - Reference to models folder
• app-services - Reference to services folder
• app-utils - Reference to utils folder

First step

Install the dependencies

npm install

# ou

yarn

Running the project

Run the following command to run the project

npm run dev

# ou

yarn dev

the project will run on port 3000 http://localhost:3000

Alias ​​Usage Example

Inside the components folder we have an index.js file, which exports all the components we have in the project.

You can import a component using the app-components alias that references this folder

Exemple

import { MyComponent } from 'app-components'

If you import more than one component, just separate them with a comma

Exemple

import { MyComponent, AnotherComponent } from 'app-components'

Build for production

Execute the command

npm run build

# ou

yarn build

Tests

Execute the command

npm test

# ou

yarn test

API reference

This project uses the API below

https://jsonplaceholder.typicode.com/

Developer: Lucas de Melo Lima