mirror of
https://github.com/Sendouc/sendou.ink.git
synced 2026-06-02 22:26:57 -05:00
update readme
This commit is contained in:
parent
03af9fa7bb
commit
a1a7693267
44
README.md
44
README.md
|
|
@ -1,30 +1,38 @@
|
|||
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).
|
||||
[](https://discord.gg/sendou)
|
||||
|
||||
## Getting Started
|
||||
Goal of sendou.ink is to provide useful tools and resources for the Splatoon community.
|
||||
|
||||
First, run the development server:
|
||||
Live version: [https://sendou.ink/](https://sendou.ink/)
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
```
|
||||
> :warning: **This is the overhaul branch**: Live version is still on the old version
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
## Technologies used
|
||||
|
||||
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
|
||||
- React (via Next.JS)
|
||||
- TypeScript
|
||||
- Node.js
|
||||
- PostgreSQL (via Prisma 2)
|
||||
|
||||
## Learn More
|
||||
## A few highlight features
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
🦑 Planner tool where you can draw on any map in the game to conveniently make up game plans
|
||||
|
||||
- [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.
|
||||
🦑 Calendar that collects together all the events happening in the community
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
||||
🦑 Users can make an account and submit their builds and browse builds made by others
|
||||
|
||||
## Deploy on Vercel
|
||||
🦑 It is possible to submit yourself as "free agent". If two FA's like each other they are notified and a new team can be founded
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
🦑 X Rank Top 500 results can be browsed through far more conveniently than on the official app
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
||||
🦑 Browse through detailed tournament results
|
||||
|
||||
🦑 Choose between light and dark mode
|
||||
|
||||
## Installation & getting started
|
||||
|
||||
TODO
|
||||
|
||||
## Contributing
|
||||
|
||||
TODO
|
||||
|
|
|
|||
|
|
@ -161,7 +161,7 @@ const AvatarWithInfo: React.FC<AvatarWithInfoProps> = ({
|
|||
</Flex>
|
||||
)}
|
||||
{!!user.player?.switchAccountId && (
|
||||
<Box mt={2}>
|
||||
<Box mt={2} color={gray}>
|
||||
<NextLink href={`/player/${user.player?.switchAccountId}`}>
|
||||
<ChakraLink>
|
||||
<Trans>View all Top 500 results</Trans>
|
||||
|
|
|
|||
|
|
@ -289,7 +289,8 @@ const ProfileModal: React.FC<Props> = ({ onClose, user }) => {
|
|||
value={watchBio!}
|
||||
maxLength={PROFILE_CHARACTER_LIMIT}
|
||||
placeholder={i18n._(
|
||||
t`# I'm a header\nI'm **bolded**. Embedding weapon images is easy too: :luna_blaster:`
|
||||
t`# I'm a header
|
||||
I'm **bolded**. Embedding weapon images is easy too: :luna_blaster:`
|
||||
)}
|
||||
/>
|
||||
</ModalBody>
|
||||
|
|
@ -297,6 +298,7 @@ const ProfileModal: React.FC<Props> = ({ onClose, user }) => {
|
|||
<Button
|
||||
mr={3}
|
||||
type="submit"
|
||||
// FIXME:
|
||||
//isLoading={loading}
|
||||
>
|
||||
<Trans>Save</Trans>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
import { Button, Divider, Select } from "@chakra-ui/react";
|
||||
import { t, Trans } from "@lingui/macro";
|
||||
import { useLingui } from "@lingui/react";
|
||||
import { RankedMode } from "@prisma/client";
|
||||
import BuildCard from "components/builds/BuildCard";
|
||||
import Breadcrumbs from "components/common/Breadcrumbs";
|
||||
|
|
@ -93,6 +94,8 @@ const ProfilePage = (props: Props) => {
|
|||
user?.id
|
||||
);
|
||||
|
||||
const { i18n } = useLingui();
|
||||
|
||||
// same as router.isFallback
|
||||
// FIXME: return spinner
|
||||
if (!user) return null;
|
||||
|
|
@ -132,10 +135,12 @@ const ProfilePage = (props: Props) => {
|
|||
maxWidth={80}
|
||||
size="lg"
|
||||
>
|
||||
<option value="ALL">All weapons ({buildCount})</option>
|
||||
{weaponCounts.map((wpnTuple) => (
|
||||
<option value={wpnTuple[0]}>
|
||||
{wpnTuple[0]} ({wpnTuple[1]})
|
||||
<option value="ALL">
|
||||
{t`All weapons`} ({buildCount})
|
||||
</option>
|
||||
{weaponCounts.map(([weapon, count]) => (
|
||||
<option key={weapon} value={weapon}>
|
||||
{i18n._(weapon)} ({count})
|
||||
</option>
|
||||
))}
|
||||
</Select>
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user