livramatheus/readme_template

This is the README template that I use on my projects

[project_name]

• English documentation
• Documentação em português

---

English Documentation

📜 Table of content

• About the project
• Live demo
• Features
• Front-end
• Layout
• Technologies
• Back-end
• External APIs
• Technologies
• Database
• How to set up
• Inspirations
• Author

💻 About the project

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

🌐 Live demo

Check out this project running on [project_host]

🔎 Features

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

Front-end

The client-side of [project_name] [project_info_text]

📐 Layout

Mobile

[project_mobile_images]

Desktop

[project_desktop_images]

🔨 Technologies

The following technologies were used to build [project_name] front-end:

• [project_technology_front_1]
• [project_technology_front_2]
• [project_technology_front_3]

Back-end

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

💱 External APIs

The following third-party APIs were used on [project_name]:

• [project_api_1]
• [project_api_2]
• [project_api_3]

🔨 Technologies

The following technologies were used to build [project_name] server:

• [project_technology_back_1]
• [project_technology_back_2]
• [project_technology_back_3]

Database

[project_name] database of choice was [project_database_name]. Check out a brief description of the tables:

• [project_table_1]: [project_table_1_description];
• [project_table_2]: [project_table_2_description];
• [project_table_3]: [project_table_3_description];

❓ How to set up

If you wish to work with this project you'll need to set up the following environment variables:

Client-side:

• [project_front_var_1] ([project_front_var_1_desc])
• [project_front_var_2] ([project_front_var_2_desc])
• [project_front_var_3] ([project_front_var_3_desc])

Server-side:

• [project_back_var_1] ([project_back_var_1_desc])
• [project_back_var_2] ([project_back_var_2_desc])
• [project_back_var_3] ([project_back_var_3_desc])

😁 Inspirations

[project_name] was inspired by the following projects on Figma:

• [project_inspiration_1_desc]
• [project_inspiration_2_desc]

👩‍🦲 Author

Developed by Matheus do Livramento.

GitHub | LinkedIn | Website

---

Documentação em português

📜 Tabela de conteúdo

• Sobre o projeto
• Live demo
• Funcionalidades
• Front-end
• Layout
• Tecnologias
• Back-end
• APIs externas
• Technologies
• Banco de dados
• Como configurar
• Inspirações
• Autor

💻 Sobre o projeto

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

🌐 Live demo

Veja este projeto rodando no [project_host]

🔎 Funcionalidades

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

Front-end

O front-end de [project_name] [project_info_text_br]

📐 Layout

Mobile

[project_mobile_images]

Desktop

[project_desktop_images]

🔨 Tecnologias

As seguintes tecnologias foram utilizadas para construir o front-end de [project_name]:

• [project_technology_front_1]
• [project_technology_front_2]
• [project_technology_front_3]

Back-end

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

💱 APIs externas

As seguintes APIs de terceiros foram usadas para desenvolver [project_name]:

• [project_api_1]
• [project_api_2]
• [project_api_3]

🔨 Tecnologias

As seguintes tecnologias foram utilizadas para desenvolver o sevidor de [project_name]:

• [project_technology_back_1]
• [project_technology_back_2]
• [project_technology_back_3]

Banco de Dados

O banco de dados escolhido para desenvolver [project_name] foi o [project_database_name]. Veja a seguir uma breve descrição de suas tabelas:

• [project_table_1]: [project_table_1_description_br];
• [project_table_2]: [project_table_2_description_br];
• [project_table_3]: [project_table_3_description_br];

❓ Como configurar

Se você deseja trabalhar com este projeto, será necessário configurar as seguintes variáveis de ambiente:

Client-side:

• [project_front_var_1] ([project_front_var_1_desc_br])
• [project_front_var_2] ([project_front_var_2_desc_br])
• [project_front_var_3] ([project_front_var_3_desc_br])

Server-side:

• [project_back_var_1] ([project_back_var_1_desc_br])
• [project_back_var_2] ([project_back_var_2_desc_br])
• [project_back_var_3] ([project_back_var_3_desc_br])

😁 Inspirações

[project_name] foi inspirado pelos seguintes projetos do Figma:

• [project_inspiration_1_desc]
• [project_inspiration_2_desc]

👩‍🦲 Autor

Desenvolvido por Matheus do Livramento.

GitHub | LinkedIn | Website