Skip to content

Commit

Permalink
feat(readme): added proper readme
Browse files Browse the repository at this point in the history
# Conflicts:
#	README.md
  • Loading branch information
cosimochellini committed Jan 2, 2022
1 parent c78f4b1 commit bdae690
Showing 1 changed file with 30 additions and 10 deletions.
40 changes: 30 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,44 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# AWS shareable files

## Getting Started
## Project purpose

First, run the development server:
- This project allows you to upload new files to s3
- This project allows you to add/edit/remove emails stored in a Dynamo DB instance
- This project allows you to send the files stored in s3 to the recipients on the Dynamo DB
- This project allows you to convert files on s3 into other formats, such as .docx to .pdf

## Project technologies

- [Next.js](https://nextjs.org/) + [React](https://reactjs.org/) + [Typescript](https://www.typescriptlang.org/) for the UI
- [Next.js API Routes](https://nextjs.org/docs/api-routes/introduction) for the serverless api
- [Material UI](https://mui.com/) for the graphic component library
- AWS ([DynamoDB](https://aws.amazon.com/dynamodb/), [S3](https://aws.amazon.com/s3/), [Lambda](https://aws.amazon.com/lambda/), [SES](https://aws.amazon.com/ses/)) for the cloud infrastructure

## Project setup

```bash
yarn
```

### Compiles and hot-reloads for development

```bash
npm run dev
# or
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Compiles and minifies for production

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
```bash
yarn build
```

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
### Lints and fixes files

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
```bash
yarn lint
```

## Learn More
## Learn More about Next.js

To learn more about Next.js, take a look at the following resources:

Expand Down

0 comments on commit bdae690

Please sign in to comment.