Skip to content

Commit

Permalink
add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vitinho163 committed Sep 6, 2024
1 parent 832350f commit 9303451
Showing 1 changed file with 136 additions and 0 deletions.
136 changes: 136 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
<h1 align="center">CodeBook</h1>

<div align="center">
<a href="#english">English</a> |
<a href="#portugues">Português</a>
</div>

---

# English <a name = "english"></a>

CodeBook is a web application designed to help users search for technology-related books and view detailed information about them, including where to purchase them.

## Summary

- [Technologies Used](#tecnologies-used-en)
- [Project Structure](#project_structure_en)
- [Installation](#installation-en)
- [Accessing the Application](#accessing-the-application-en)
- [Screenshot](#screenshot-en)
- [Author](#author-en)

## 🚀 Technologies Used <a name = "tecnologies-used-en"></a>

- **[HTML]**(https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/HTML_basics): Markup language for creating web pages.
- **[CSS]**(https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/CSS_basics): Style sheet language for designing the presentation of web pages.
- **[JavaScript]**(https://developer.mozilla.org/en-US/docs/Web/JavaScript): Programming language that allows you to implement dynamic features on web pages.


## 📁 Structure of the project <a name = "project_structure_en"></a>
The project structure is as follows:
```
├── index.html: Main HTML file.
├── style.css: Stylesheet for the application.
├── app.js: Main JavaScript file that handles book search functionality.
├── dados.js: JavaScript file containing the book data.
```

## 🛠️ Installation <a name = "installation-en"></a>

1. Clone the repository or download and extract the ZIP file from the repository.
```bash
git clone https://github.com/Vitinho163/CodeBook.git
```

2. Open the project folder:
```bash
cd CodeBook
```

3. Open the ``index.html`` file in your preferred browser to view the application.


## 🌐 Accessing the Application <a name="accessing-the-application-en"></a>

You can view the project online at the following link: [View CodeBook Online](https://vitinho163.github.io/CodeBook/)

Alternatively, open the application locally by opening the ``index.html`` file in your browser.

## 🖼️ Screenshot <a name="screenshot-en"></a>

![Screenshot_1](https://imgur.com/WrERq2G.png)
![Screenshot_2](https://imgur.com/1HebEoC.png)
![Screenshot_3](https://imgur.com/hkuXSuu.png)

<div align="center" name="author-en">
<h4>Created with ❤️ by <a href="https://github.com/Vitinho163">João Victor</a></h4>
</div>

---
<br>

# Português <a name = "portugues"></a>

CodeBook é uma aplicação que permite aos usuários pesquisar por livros relacionados à tecnologia, fornecendo informações-chave como título, descrição, autor, número de páginas e um link para compra.

## Sumário

- [Tecnologias Utilizadas](#tecnologias-usadas-pt)
- [Estrutura do Projeto](#estrutura-do-projeto-pt)
- [Instalação](#instalacao-pt)
- [Acessando a Aplicação](#acessando-a-aplicacao-pt)
- [Screenshot](#screenshot-pt)
- [Autor](#autor-pt)

## 🚀 Tecnologias Utilizadas <a name = "tecnologias-usadas-pt"></a>

- **[HTML]**(https://developer.mozilla.org/pt-BR/docs/Learn/Getting_started_with_the_web/HTML_basics): Linguagem de marcação para criação de páginas web.
- **[CSS]**(https://developer.mozilla.org/pt-BR/docs/Learn/Getting_started_with_the_web/CSS_basics): Linguagem de estilo para a apresentação de páginas web.
- **[JavaScript]**(https://developer.mozilla.org/pt-BR/docs/Web/JavaScript): Linguagem de programação que permite implementar funcionalidades dinâmicas em páginas web.

## 📁 Estrutura do Projeto <a name = "estrutura-do-projeto-pt"></a>
A estrutura do projeto é a seguinte:
```
├── index.html: Arquivo principal HTML.
├── style.css: Folha de estilos da aplicação.
├── app.js: Arquivo principal JavaScript que gerencia a funcionalidade de busca de livros.
├── dados.js: Arquivo JavaScript contendo os dados dos livros.
```

## 🛠️ Instalação <a name = "instalacao-pt"></a>

1. Clone o repositório ou faça o download e extraia o arquivo ZIP do repositório.
```bash
git clone https://github.com/Vitinho163/CodeBook.git
```

2. Abra a pasta do projeto:
```bash
cd CodeBook
```

3. Abra o arquivo ``index.html`` no seu navegador preferido para visualizar a aplicação.


## 🌐 Acessando a Aplicação <a name="acessando-a-aplicacao-pt"></a>

Você pode visualizar o projeto online no seguinte link: [Ver CodeBook Online](https://vitinho163.github.io/CodeBook/)

Ou abrir a aplicação localmente abrindo o arquivo ``index.html`` no seu navegador.

## 🖼️ Screenshot <a name="screenshot-pt"></a>

![Screenshot_1](https://imgur.com/WrERq2G.png)
![Screenshot_2](https://imgur.com/1HebEoC.png)
![Screenshot_3](https://imgur.com/hkuXSuu.png)

<div align="center" name="autor-pt">
<h4>Criado com ❤️ por <a href="https://github.com/Vitinho163">João Victor</a></h4>
</div>

0 comments on commit 9303451

Please sign in to comment.