Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonardospereira/rocketnotes
https://github.com/leonardospereira/rocketnotes
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/leonardospereira/rocketnotes
- Owner: LeonardoSPereira
- Created: 2023-10-13T16:54:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T16:22:57.000Z (6 months ago)
- Last Synced: 2024-05-29T04:11:21.276Z (6 months ago)
- Language: JavaScript
- Homepage: https://rocket-notes-olive.vercel.app
- Size: 1.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
RocketNotes
[Layout](https://www.figma.com/file/vbhnucuBMl5dpDhleG0BmQ/RocketNotes-(Copy)?type=design&mode=design&t=aq1522HcyXAeFv6l-1)
[Português](#pt)
/
[English](#en)
# Português
- [Sobre](#about_pt)
- [Iniciando o projeto](#getting_started_pt)
- [Usando](#usage_pt)
- [Tecnologias](#built_using_pt)
## 🧐 Sobre
Este projeto foi criado durante o curso Exporer da Rocketseat, com o objetivo de listar notas, além de possibilitar adicionar links e tags para cada nota.
Essas instruções vão te guiar para ter uma cópia da aplicação funcionando em sua máquina local.
### Pré-requisitos
Inicialmente você vai precisar de alguns programas instalados para que consiga fazer uso:
- [Visual Studio Code](https://code.visualstudio.com) - Editor de código
- [Node.js + npm](https://nodejs.org/en) - Versão LTS recomendada
### Instalando
Instruções passo a passo para utilizar a aplicação:
Feita a instalação mencionada, faça uma cópia do código fonte ou o download para sua máquina.
Abra os arquivos com o VSCODE e em seguida, abra o seu terminal integrado e execute o seguinte código:
```
npm install
```
Esse comando irá instalar todas as dependências necessárias para que consiga utilizar a aplicação.
Primeiramente, acesse o arquivo "api.js", localizado dentro da pasta "src/services" e selecione a url do backend que deseja utilizar.
*Caso escolha pela url de desenvolvimento, você precisará de uma cópia dos arquivos do backend rodando em sua máquina local. Para isso, todos os detalhes de utilização estão disponíveis [aqui](https://github.com/LeonardoSPereira/RocketNotesBackEnd).*
Tendo executado o servidor local e com a cópia do backend em execução, execute a linha de comando a seguir para iniciar o servidor local:
```
npm run dev
```
Após, clique no link informado no terminal ou o digite no seu navegador:
```
http://localhost:5173
```
Com isso, você deverá conseguir acessar a aplicação normalmente
- [HTML](https://developer.mozilla.org/pt-BR/docs/Web/HTML)
- [CSS](https://developer.mozilla.org/pt-BR/docs/Web/CSS)
- [JavaScript](https://developer.mozilla.org/pt-BR/docs/Web/JavaScript)
- [ReactJs](https://react.dev)
- [Vite](https://vitejs.dev)
- [NodeJs](https://nodejs.org/en/)
- [Styled Components](https://styled-components.com)
- [React Router DOM](https://reactrouter.com/en/main)
- [React Icons](https://react-icons.github.io/react-icons/)
## 📝 Table of Contents
- [About](#about_en)
- [Getting Started](#getting_started_en)
- [Usage](#usage_en)
- [Technologies](#built_using_en)
## 🧐 About
This project was created during the Rocketseat Explorer course with the aim of listing notes, as well as allowing the addition of links and tags for each note.
These instructions will guide you to have a copy of the application running on your local machine.
### Prerequisites
You'll need a few programs installed to get started:
- [Visual Studio Code](https://code.visualstudio.com) - Code editor
- [Node.js + npm](https://nodejs.org/en) - Recommended LTS version
### Installing
Step-by-step instructions to use the application:
Once you've installed the mentioned software, make a copy of the source code or download it to your machine.
Open the files with VSCODE and then open your integrated terminal and execute the following code:
```
npm install
```
This command will install all the necessary dependencies to use the application.
Firstly, access the "api.js" file located inside the "src/services" folder and select the URL of the backend you want to use.
*If you choose to use the development URL, you'll need a copy of the backend files running on your local machine. All usage details are available [here](https://github.com/LeonardoSPereira/RocketMoviesBackEnd).*
Once the local server is running and you have the backend copy running, execute the following command line to start the local server:
```
npm run dev
```
Then, click on the link provided in the terminal or enter it into your browser:
```
http://localhost:5173
```
With that, you should be able to access the application normally.
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [ReactJs](https://react.dev)
- [Vite](https://vitejs.dev)
- [NodeJs](https://nodejs.org/en/)
- [Styled Components](https://styled-components.com)
- [React Router DOM](https://reactrouter.com/en/)
- [React Icons](https://react-icons.github.io/react-icons/)