-
Notifications
You must be signed in to change notification settings - Fork 143
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
6 changed files
with
49 additions
and
24 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,36 +1,47 @@ | ||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). | ||
 | ||
|
||
## Getting Started | ||
Watch your favourite anime anywhere, anytime. No Ads. | ||
|
||
First, run the development server: | ||
Previously called [**AnimeWorldz**](https://github.com/Dovakiin0/Kitsune/tree/v2.0), Kitsune is a free, open-source anime streaming website. It is built using the [Next Js](https://nextjs.org/) framework and [Tailwind CSS](https://tailwindcss.com/). | ||
|
||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
# or | ||
pnpm dev | ||
# or | ||
bun dev | ||
``` | ||
_Kitsune is still under development and may encounter many bugs. Feel free to open any issue regarding bugs or features_ | ||
|
||
Also checkout the mobile app: [Android](https://github.com/Dovakiin0/animeworldz-mobile), which is still called AnimeWorldz but will later be updated. | ||
|
||
## Features | ||
|
||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
- **No Ads** - No ads, no popups, no redirects, no bullshit. | ||
- **PWA Support** - Kitsune is a PWA, which means you can install it on your phone. | ||
|
||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. | ||
## Contributing | ||
|
||
``` | ||
fork the repo | ||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. | ||
git clone <forked-repo> | ||
git checkout -b <new-feature> | ||
git add <changed-file> | ||
git commit -m "New feature" | ||
git push origin <new-feature> | ||
## Learn More | ||
then submit a pull request | ||
``` | ||
|
||
To learn more about Next.js, take a look at the following resources: | ||
## Local Development | ||
|
||
- [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. | ||
``` | ||
clone the repo | ||
cd kitsune/ | ||
npm install or yarn | ||
``` | ||
|
||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! | ||
rename the `.env.example` file to `.env` then set in TMDB access key (READ ACCESS TOKEN) and vercel KV(optional). | ||
then run the app | ||
|
||
## Deploy on Vercel | ||
``` | ||
npm run dev or yarn dev | ||
``` | ||
|
||
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. | ||
## Support | ||
|
||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. | ||
Join the Discord server: <https://discord.gg/6yAJ3XDHTt> |
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
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
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
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