Skip to content

Latest commit

 

History

History
99 lines (82 loc) · 4.11 KB

README.md

File metadata and controls

99 lines (82 loc) · 4.11 KB
Raw

LandPage React

Para a versão em português deste README, clique aqui.

Project description

LandPage created with react and typescript inspired by the landpage of Inbound Emotion

GitHub language count GitHub top language GitHub repo size GitHub GitHub release (latest by date)

Installation

Clone the repo:

git clone https://github.com/EuCarlos/landpage-react.git && cd landpage-react

Install the dependencies using Yarn:

yarn install // or -> npm install

Environment variables

create an .env file like the .env.example and fill in your github credentials

Run the project

Start a react server:

yarn dev // or -> npm run dev

The project

General Objective:

Develop a functional landpage and integrate theory and practice of acquired knowledge to reality.

Functional requirements

  • [FR001] - The system must have a form that receives the following fields: Name, Email, Company and Website.
  • [FR002] - The system should show a message after submitting the form.
  • [FR003] - The system should send an email for notification about the expected content.
  • [FR004] - The system must count the number of people who filled out the form.
  • [FR005] - The system should show (somewhere on the landpage) comments on related content.

Non-functional requirements

  • [NFR001] - The System must be responsive (adaptable for desktop, tablets and mobile phones).
  • [NFR002] - The system should be developed using React and TypeScript.
  • [NFR003] - The system must be connected to a message sending API (created by me).
  • [NFR004] - The system should have a good interface for man and machine interaction.
  • [NFR005] - The system should receive variables from environments.

Project prototype

image

The project is a landpage where a text (in Portuguese) with general information about the e-book is presented, with a form on the right side of the screen. On the website screen, comments from people who received your e-book by e-mail are also shown and report on the experience. At the bottom of the page there are buttons to access Github, LinkedIn, Dribbble, Instagram and the personal website of the landpage author.

Directory structure

.
├── src
│    ├── components
│    │    ├── LandingForm
│    │    │      ├── index.tsx
│    │    │      └── styles.module.sass
│    │    ├── MessageList
│    │    │      ├── index.tsx
│    │    │      └── styles.module.sass
│    │    └── Menu
│    │           ├── index.tsx
│    │           └── styles.module.sass
│    ├── images
│    │    ├── image.svg
│    │    └── logo.svg
│    ├── database
│    │    └── messageList.example.json
│    ├── pages
│    │    └── Home
│    │          ├── index.tsx
│    │          └── styles.module.sass
│    ├── services
│    │    └── api.ts
│    ├── App.tsx
│    ├── main.tsx
│    ├── styles.module.sass
│    └── vite-env.d.ts
├── .gitignore
├── index.html
├── package.json
├── README.md
├── tsconfig.json
├── vite.config.ts
└── yarn.lock

Created with heart 💜 by Carlos Alves