Skip to content

Commit 571f56c

Browse files
committed
chore: update docs and revert compose file
1 parent 6436b68 commit 571f56c

File tree

4 files changed

+55
-93
lines changed

4 files changed

+55
-93
lines changed

.github/workflows/ci.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
jobs:
8+
test:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: Setup Node.js
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: '20'
18+
cache: 'pnpm'
19+
20+
- name: Install pnpm
21+
uses: pnpm/action-setup@v2
22+
with:
23+
version: 8
24+
25+
- name: Install dependencies
26+
run: pnpm install
27+
28+
- name: Build
29+
run: pnpm build

README.md

Lines changed: 25 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,46 @@
1-
<p align="center">
2-
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
3-
</p>
4-
5-
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
6-
[circleci-url]: https://circleci.com/gh/nestjs/nest
7-
8-
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
9-
<p align="center">
10-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
11-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
12-
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
13-
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
14-
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
15-
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
16-
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
17-
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
18-
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
19-
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
20-
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
21-
</p>
22-
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
23-
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
24-
25-
## Description
26-
27-
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
28-
29-
## Project setup
1+
## Arweave Data Upload Service
302

31-
```bash
32-
$ pnpm install
33-
```
3+
This service is used with Arweave Storage SDK to upload data to Arweave and pay for the storage using other chains tokens.
344

35-
## Compile and run the project
5+
## Prerequisites
366

37-
```bash
38-
# development
39-
$ pnpm run start
7+
- Docker
8+
- Node.js (>= v20.18.3)
9+
- pnpm (>= v9.14.2)
4010

41-
# watch mode
42-
$ pnpm run start:dev
11+
## Installation
4312

44-
# production mode
45-
$ pnpm run start:prod
13+
```bash
14+
pnpm install
4615
```
4716

48-
## Run tests
17+
## Running the service
4918

5019
```bash
51-
# unit tests
52-
$ pnpm run test
53-
54-
# e2e tests
55-
$ pnpm run test:e2e
56-
57-
# test coverage
58-
$ pnpm run test:cov
20+
pnpm start:dev
5921
```
6022

61-
## Deployment
62-
63-
When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
64-
65-
If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
23+
## Running the service in production mode
6624

6725
```bash
68-
$ pnpm install -g mau
69-
$ mau deploy
26+
pnpm start:prod
7027
```
7128

72-
With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
73-
74-
## Resources
29+
## Prisma migrations
7530

76-
Check out a few resources that may come in handy when working with NestJS:
77-
78-
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
79-
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
80-
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
81-
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
82-
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
83-
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
84-
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
85-
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
86-
87-
## Support
31+
```bash
32+
pnpm db:migrate:dev
33+
```
8834

89-
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
35+
```bash
36+
pnpm db:migrate:prod
37+
```
9038

91-
## Stay in touch
39+
## Prisma Studio
9240

93-
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
94-
- Website - [https://nestjs.com](https://nestjs.com/)
95-
- Twitter - [@nestframework](https://twitter.com/nestframework)
41+
```bash
42+
pnpm db:studio
43+
```
9644

97-
## License
45+
## Running the service in development mode
9846

99-
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).

docker-compose.yml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
11
version: '3.8'
22

33
services:
4-
arweave_storage_api:
5-
build:
6-
context: .
7-
dockerfile: Dockerfile
8-
container_name: arweave_storage_api
9-
restart: always
10-
ports:
11-
- '3000:3000'
12-
env_file:
13-
- .env
14-
depends_on:
15-
- arweave_storage_postgres
16-
- arweave_storage_redis
17-
184
arweave_storage_postgres:
195
image: postgres:alpine
206
container_name: arweave_storage_postgres

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"docker:start": "docker compose up -d",
2020
"docker:start:test": "dotenv -e .env.test -- docker compose -f docker-compose-test.yml up -d",
2121
"docker:down:test": "dotenv -e .env.test -- docker compose -f docker-compose-test.yml down",
22-
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
22+
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
2323
"test": "jest",
2424
"test:watch": "jest --watch",
2525
"test:cov": "jest --coverage",

0 commit comments

Comments
 (0)