Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/techeng322/realworld-website
The source code of the RealWorld website
https://github.com/techeng322/realworld-website
Last synced: 18 days ago
JSON representation
The source code of the RealWorld website
- Host: GitHub
- URL: https://github.com/techeng322/realworld-website
- Owner: techeng322
- License: mit
- Created: 2023-11-08T19:54:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-03T22:02:53.000Z (about 1 year ago)
- Last Synced: 2024-01-15T10:34:58.800Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 217 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RealWorld Website
This repository contains the source code of the [RealWorld](https://realworld.io) website.
## About
The website is a single-page application created with [Layr](https://github.com/layrjs/layr). The frontend is statically hosted in AWS S3 + CloudFront and the backend is serverlessly hosted in AWS Lambda + API Gateway. Regarding the database, it is a free-tier MongoDB Atlas cluster with a daily backup that is handled by a Lambda function.
## Install
Install the npm dependencies with:
```sh
npm install
```
## Develop
### Prerequisites
- Make sure you have [Docker](https://www.docker.com/) installed as it is used to execute the MongoDB development database.
- Create a [GitHub OAuth App](https://github.com/settings/developers) with the following settings:
- Homepage URL: `http://localhost:15541`
- Authorization callback URL: `http://localhost:15541/oauth/callback`
- Create a [GitHub personal access token](https://github.com/settings/tokens) with no scopes selected.
- Generate a JWT secret by running the following command in your terminal:
- `openssl rand -hex 64`
### Running the website in development mode
Execute the following command while replacing the `"********"` with the information obtained above:
```sh
FRONTEND_URL=http://localhost:15541 \
BACKEND_URL=http://localhost:15542 \
EMAIL_ADDRESS="********" \
MONGODB_STORE_CONNECTION_STRING=mongodb://test:test@localhost:15543/test \
GITHUB_CLIENT_ID="********" \
GITHUB_CLIENT_SECRET="********" \
GITHUB_PERSONAL_ACCESS_TOKEN="********" \
JWT_SECRET="********" \
npm run start
```
The website should then be available at http://localhost:15541.
### Migrating the database
Navigate to the `./backend` directory and execute the following command:
```sh
FRONTEND_URL=http://localhost:15541 \
BACKEND_URL=http://localhost:15542 \
EMAIL_ADDRESS="********" \
MONGODB_STORE_CONNECTION_STRING=mongodb://test:test@localhost:15543/test \
GITHUB_CLIENT_ID="********" \
GITHUB_CLIENT_SECRET="********" \
GITHUB_PERSONAL_ACCESS_TOKEN="********" \
JWT_SECRET="********" \
npm run migrate
```
## Debug
### Client
Add the following entry in the local storage of your browser:
```
| Key | Value |
| ----- | --------- |
| debug | layr:* |
```
### Server
Add the following environment variables when starting the website:
```sh
DEBUG=layr:* DEBUG_DEPTH=10
```
## Deploy
## Deploying to AWS
Create an AWS IAM role:
- Trusted entity: `AWS service`
- Use case: `Lambda`
- Name: `realworld-website-backend-prod`
- Permission policies:
- CloudWatchLogsFullAccess
- AmazonSESFullAccess
Execute the following command:
```sh
FRONTEND_URL=https://realworld.mvila.me \
BACKEND_URL=https://backend.realworld.mvila.me \
EMAIL_ADDRESS="********" \
MONGODB_STORE_CONNECTION_STRING="********" \
GITHUB_CLIENT_ID="********" \
GITHUB_CLIENT_SECRET="********" \
GITHUB_PERSONAL_ACCESS_TOKEN="********" \
JWT_SECRET="********" \
npm run deploy
```
Add an AWS EventBridge rule to automatically run an hourly task:
- Name: `realworld-website-hourly-task`
- Schedule:
- Fixed rate every: `1 hour`
- Target:
- Lambda function: `backend-realworld-mvila-me`
- Constant input: `{"query": {"<=": {"__component": "typeof Application"}, "runHourlyTask=>": {"()": []}}}`
Add another AWS EventBridge rule to automatically run a daily task:
- Name: `realworld-website-daily-task`
- Schedule:
- Fixed rate every: `1 day`
- Target:
- Lambda function: `backend-realworld-mvila-me`
- Constant input: `{"query": {"<=": {"__component": "typeof Application"}, "runDailyTask=>": {"()": []}}}`
## License
MIT