Skip to content

Commit 535fe36

Browse files
committed
README作成
1 parent 16eea9a commit 535fe36

File tree

1 file changed

+50
-64
lines changed

1 file changed

+50
-64
lines changed

README.md

Lines changed: 50 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,50 @@
1-
# Node, PostgreSQL and GraphQL (NPG) Boilerplate
2-
3-
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
4-
5-
This is a free quick-to-use boilerplate for setting up your backend API with Node, GraphQL and PostgreSQL.
6-
This is meant to quickly set you up for frontend development.
7-
8-
This GraphQL API is powered by [postgraphile](https://www.graphile.org/postgraphile/introduction/)
9-
10-
This repository contains:
11-
12-
1. A containerized Node GraphQL API
13-
2. A containerized PostgreSQL Database
14-
3. An environment variables, `env`, file
15-
16-
## Table of Contents
17-
18-
- [Background](#background)
19-
- [Usage](#usage)
20-
- [Modifying the Schema](#modifying-the-schema)
21-
- [Maintainers](#maintainers)
22-
- [Contributing](#contributing)
23-
- [License](#license)
24-
25-
## Background
26-
27-
Everybody wants to quickly set up their Backend APIs. As such, this repo was made exactly for that purpose. Th
28-
29-
## Usage
30-
31-
To set up your Node GraphQL API, simply run
32-
33-
```
34-
docker-compose up --build
35-
```
36-
37-
After your containers have finished setting up, you should be able to access `http://localhost:3000/graphiql` and see the following:
38-
39-
![GraphiQL Sample](https://raw.githubusercontent.com/RedTint/node-postgraphile-boilerplate/master/assets/sample-output.png)
40-
41-
Upon seeing the above interface, you should be able to start working on your frontend application.
42-
43-
### Modifying the Schema
44-
45-
I have only created a sample database schema to get you up and running.
46-
Feel free to add scripts [here](https://github.com/RedTint/node-postgraphile-boilerplate/tree/master/db/scripts)
47-
48-
## Maintainers
49-
50-
[@RedTint](https://github.com/RedTint).
51-
52-
## Contributing
53-
54-
Feel free to dive in! [Open an issue](https://github.com/RedTint/node-postgraphile-boilerplate/issues/new) or submit PRs.
55-
56-
Standard Readme follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) Code of Conduct.
57-
58-
### Contributors
59-
60-
Only me at this point. =)
61-
62-
## License
63-
64-
[MIT](LICENSE) © Algefmarc Anthony L. Almocera
1+
# ポートフォリオ
2+
3+
## 使用技術
4+
5+
- next.js
6+
- tailwind
7+
- mantine
8+
- Ant Design Charts
9+
- postgraphile
10+
- graphQL
11+
- graphql-codegen
12+
- firebase auth
13+
14+
## ページ一覧
15+
16+
- インデックスページ(ISR)
17+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/)
18+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/index.tsx)
19+
- 新規登録ページ(SSG)
20+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/signup)
21+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/signup/index.tsx)
22+
- ログインページ(SSG)
23+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/signin)
24+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/signin/index.tsx)
25+
- ユーザー削除ページ(SSG)
26+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/delete-user)
27+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/delete-user/index.tsx)
28+
- 投稿閲覧ページ(ISR)
29+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/posts/103)
30+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/posts/%5Bpid%5D/index.tsx)
31+
- 新規投稿ページ(SSR)
32+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/posts/new)
33+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/posts/new/index.tsx)
34+
- 投稿編集ページ(SSR)
35+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/posts/103/edit)
36+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/posts/%5Bpid%5D/edit.tsx)
37+
- 404 ページ(SSG)
38+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/tekitou)
39+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/404.tsx)
40+
- データ閲覧ページ(ISR)
41+
- [実際のページ](https://postgraphile-next-tailwind-mantin-graphql-portfolio.vercel.app/data)
42+
- [ソースコード](https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/pages/data/index.tsx)
43+
44+
## その他
45+
46+
- Apollo の設定してるファイル: https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/master/nextjs/src/contexts/MyApolloProvider.tsx
47+
48+
- next.js のフォント最適化: https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/5da04f755e7a93b208f2c0b88ea74922b027b2b0/nextjs/src/pages/_app.tsx#L34
49+
50+
- Mantine のデフォルトテーマのカスタマイズ: https://github.com/msickpaler/postgraphile-next-tailwind-mantin-graphql-portfolio/blob/5da04f755e7a93b208f2c0b88ea74922b027b2b0/nextjs/src/pages/_app.tsx#L46

0 commit comments

Comments
 (0)