Skip to content

Commit

Permalink
Update readme and add license (#31)
Browse files Browse the repository at this point in the history
* Update README.md
* Create LICENSE
  • Loading branch information
oktay authored Jul 18, 2022
1 parent 98bfd2a commit a888483
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 20 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Oktay Çolakoğlu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
51 changes: 31 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,45 @@
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).
# oktaycolakoglu-2022

## Getting Started
My personal homepage with NextJS & Tailwind CSS

First, run the development server:
## Description

```bash
npm run dev
# or
yarn dev
```
This project made with Next JS, uses Tailwind CSS for styling. It's a personal homepage for me. It's a simple project with only one page and it uses Dato CMS for content management, Github API for show Github activities, and Dribbble API for show last dribbble shots.

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Installation

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
You must provide all API keys and tokens to use this project. You can see the list in [.env.local.example](./.env.local.example) file.
You need create schemas and fields like in this project on Dato CMS, but instead of it you can remove all cms content and make all content hardcoded.

```
DRIBBBLE_TOKEN=XXXXXXXX
GITHUB_TOKEN=XXXXXXXXX
DATOCMS_TOKEN=XXXXXXXXXXX
```

[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`.
> Note: When its in development mode it will show dummy data for dribbble and github to reduce requests.
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.
### Start project

## Learn More
```
npm install
npm run dev
```

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

- [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.
Contributors names and contact info

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
- [@oktay](https://github.com/oktay)
## License

## Deploy on Vercel
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details

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.
## Sources

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
* [NextJS](https://nextjs.org/)
* [Tailwind CSS](https://tailwindcss.com/)
* [Dato CMS](https://www.datocms.com/docs/next-js)
* [Github API](https://docs.github.com/en/rest)
* [Dribbble API](https://developer.dribbble.com/v2/)
* [Next-Intl](https://www.thisdot.co/blog/next-js-adding-localization-with-next-intl)

1 comment on commit a888483

@vercel
Copy link

@vercel vercel bot commented on a888483 Jul 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.