Skip to content

Commit

Permalink
Merge pull request #1253 from NicoPennec/fix/bump-deps
Browse files Browse the repository at this point in the history
Bump dependencies (Vite 5, Node >= LTS, ...)
  • Loading branch information
frankrousseau authored Nov 29, 2023
2 parents 10caab1 + 2abeaaa commit 8be7fc5
Show file tree
Hide file tree
Showing 10 changed files with 616 additions and 282 deletions.
2 changes: 1 addition & 1 deletion .browserslistrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
> 1%
last 2 versions
not ie <= 8
not dead
File renamed without changes.
File renamed without changes.
12 changes: 6 additions & 6 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### Kitsu Development Environment with Docker

Start developing for Kitsu using Docker on Windows, Linux and OSX.
Start developing for Kitsu using Docker on Windows, Linux and macOS.

**Prerequisites**

- [Node.js 16.x](https://nodejs.org/en/) or greater
- [Docker 1.13](https://store.docker.com/search?type=edition&offering=community) or greater
- [Node.js >= 18.12](https://nodejs.org/en/)
- [Docker >= 1.13](https://store.docker.com/search?type=edition&offering=community)

**Setup**

Expand All @@ -23,12 +23,12 @@ After 30 or so seconds, a browser window should appear with Kitsu up and running

**Resources**

Kitsu is based on the VueJs framework. The VueJs documentation is exhaustive and very clear. We encourage you to read it before hacking significant piece of code.
Kitsu is based on the Vue.js framework. The Vue.js documentation is exhaustive and very clear. We encourage you to read it before hacking significant piece of code.

The architecture is based on [vuex](https://kitsu.cg-wire.com/development-environment/) and [vue-router](https://kitsu.cg-wire.com/development-environment/). Documentations are good too, again, we recommend to read it. The main idea is that:

- Url routes gives the main context.
- Views are described in components through HTML, CSS and small pieces of javascript.
- URL routes gives the main context.
- Views are described in components through HTML, CSS and small pieces of JavaScript.
- Shared state is stored inside stores which are modified through mutations (kind of event bus to require state changes) and actions.
- Actions are similar to mutations but they allow asynchronous operations. Mainly actions fire mutations and send requests to the server.
- Stores provide getter to access state properties from components.
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

# Kitsu, Collaboration Platform for Animation And VFX Studios

Kitsu is a web application to collaborate around your creative productions and
manage your deliveries. It improves the communication between all stakeholders.
Kitsu is a web application to collaborate around your creative productions and
manage your deliveries. It improves the communication between all stakeholders.
Which leads to better results, shipped faster.

[![CI badge](https://github.com/cgwire/kitsu/actions/workflows/ci.yml/badge.svg)](https://github.com/cgwire/kitsu/actions/workflows/ci.yml)
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/invite/VbCxtKN)
[![Donation](https://img.shields.io/liberapay/receives/CGWire.svg?logo=liberapay">)](https://liberapay.com/CGWire/donate)

## Documentation
## Documentation

For further information about features and installation, please refer to the
[documentation website](https://kitsu.cg-wire.com/).

## Contributing

There are many ways to contribute to Kitsu, from simple tasks to most complex ones. We created a
[contributing guide](https://github.com/cgwire/kitsu/blob/master/CONTRIBUTING.md) explaining everything.
There are many ways to contribute to Kitsu, from simple tasks to most complex ones. We created a
[contributing guide](https://github.com/cgwire/kitsu/blob/master/CONTRIBUTING.md) explaining everything.
You will find all the information you are looking for!

## Sponsors
Expand All @@ -44,7 +44,7 @@ You will find all the information you are looking for!

## About authors

Kitsu is written by CGWire, a company based in France. We help animation and VFX studios to collaborate better through efficient tooling.
Kitsu is written by CGWire, a company based in France. We help animation and VFX studios to collaborate better through efficient tooling.

More than 70 studios around the world use Kitsu for their projects.

Expand Down
15 changes: 7 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# How to create a new release for Kitsu

We release Kitsu versions through Github. Every time a new version is ready, we
follow this process:
We release Kitsu versions through GitHub.
Every time a new version is ready, we follow this process:

1. Rebase sources on the master branch.
2. Up the version number through the `npm` CLI.
1. Rebase sources on the `master` branch.
2. Up the version number through the `npm` CLI.
3. Tag the commit with the Kitsu version.
4. Push changes to `master` branch.
4. Push changes to the `master` branch.

You can run the following script to perform these commands at once:

Expand All @@ -16,11 +16,10 @@ npm version patch
git push origin master --tag
```


# Deployment

Kitsu installation have to update via Git, your Kitsu folder. Run the following
command to get the latest version of Kitsu:
Kitsu installation has to be updated via Git, your Kitsu folder.
Run the following command to get the latest version of Kitsu:

```bash
git pull --rebase origin build
Expand Down
Loading

0 comments on commit 8be7fc5

Please sign in to comment.