Skip to content

Commit

Permalink
readme: add install commands and new banner
Browse files Browse the repository at this point in the history
  • Loading branch information
kuroji-fusky authored Feb 8, 2023
1 parent 849bf10 commit c8b2308
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
<h1 align="center">
<img src="https://user-images.githubusercontent.com/94678583/178055907-c0318ec0-ea39-4c0c-b8fe-ec010b778764.png" width="127" />
<br>
<span>MyFursona</span>
</h1>
![MF banner variant 2](https://user-images.githubusercontent.com/94678583/217444477-14639857-511f-4f85-bb6b-5660da9499d6.png)

_MyFursona_ is an open source web app where users can manage their artworks, various info (such as biography, literature, socials, interests, etc.), and lore about their fursona. The project is still in the works, so a lot of breaking changes are bound to happen!
<h1 align="center">MyFursona</h1>

![UI Redesign by Jaker](https://user-images.githubusercontent.com/86149507/160653487-3b7b162a-8f1d-4d1e-8ddf-bd4eeec04189.png)
_MyFursona_ is an open source platform where users can manage their artworks, various types of media about their fursona. The project is still in the works, so a lot of breaking changes are bound to happen!

## Stack
## Contributing

![MF Stack](https://skillicons.dev/icons?i=nextjs,ts,sass,mongodb,fastify)
### Prerequisites

_MyFursona_ is built using Next.js with TypeScript, Sass, Fastify, and MongoDB. With the backend written in Go.
- Node.js versions 16 or higher (LTS recommended)
- Yarn package manager
- (Optional) WSL/Git Bash

## Design
### Installation

The website's design was initally designed by Ozzy, but it was improved by Skep & Jaker;
it's still work in progress and the Figma design can be seen [here][figma]!
Fork and clone the repository

## Contributors
```console
git clone https://github.com/MyFursona-Project/MyFursona.git
```

- **Ozzy (also known as Renzo or Vulpo)**: Full-stack developer/Co-founder
- **Mozza (also known as Solixity)**: Back-end developer/Co-founder
- **Jaker**: UI/UX designer
- **skepfusky**: Front-end design; UI/UX designer
- **Your name could be here: Our future contributor!**
Install its dependencies
```console
yarn install
```

### Contributions
To run the website; you can start a local dev server
```console
yarn dev:web
```

Your contributions are very appreciated! Before you make changes, contact Ozzy/Renzo/Vulpo via Revolt (@OzzyTheDev), Email([email protected]), Discord(OzzyTheDev#1312)
## License

[figma]: https://www.figma.com/file/3dd2FKkSSNCbPBYwhOLhTo/MyFursona?node-id=0%3A1
MIT

0 comments on commit c8b2308

Please sign in to comment.