-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,30 @@ | ||
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). | ||
## Hacker News in Japanese | ||
Hacer News is a web application that allows users to view about the top 10 articles on Hacker News in Japanese. The application is built using Next.js and utilizes both the Hacker News API and DeepL API. | ||
|
||
## Getting Started | ||
## Features | ||
* View the top 10 article titles on Hacker News in Japanese | ||
* View the number of points and comments | ||
* Utilize DeepL API for automatic translation between English and Japanese | ||
|
||
First, run the development server: | ||
## UI development | ||
|
||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
``` | ||
<img src="https://github.com/yuki-o1o5/hacker-news-in-japanese/blob/main/images/top.png" alt="top" width="400"> | ||
<img src="https://github.com/yuki-o1o5/hacker-news-in-japanese/blob/main/images/comments.png" alt="comments" width="400"> | ||
|
||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
## Installation | ||
To run the Hacker News in Japanese app locally, follow these steps: | ||
|
||
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. | ||
1. Clone the repository to your local machine. | ||
2. Install the dependencies using `npm install`. | ||
3. Start the app using `npm run dev`. | ||
4. Access the app at http://localhost:3000. | ||
|
||
[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.js`. | ||
## Technologies Used | ||
* Next.js | ||
* React | ||
* CSS | ||
|
||
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. | ||
## APIs Used | ||
[Hacker News API](https://github.com/HackerNews/API) | ||
[DeepL API](https://www.deepl.com/docs-api) | ||
|
||
## Learn More | ||
|
||
To learn more about Next.js, take a look at the following resources: | ||
|
||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
|
||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
|
||
## Deploy on Vercel | ||
|
||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
|
||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |