Skip to content

Commit

Permalink
Update all the dependencies and deprecate the themes
Browse files Browse the repository at this point in the history
The themes did not look good and they use older versions of their individual ui libraries, which caused peer dependency issues with React 18. Better to deprecate them since I have no plan to revisit them. PRs welcome to update them.
  • Loading branch information
Minivera committed Mar 22, 2023
1 parent d638290 commit 62b9f6e
Show file tree
Hide file tree
Showing 85 changed files with 13,724 additions and 18,146 deletions.
3 changes: 3 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@
"settings": {
"import/parsers": {
"@typescript-eslint/parser": [".ts", ".tsx"]
},
"react": {
"version": "detect"
}
}
}
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,26 +125,22 @@ export const Component = () => (

## Themes

React-Vitae includes two ready made themes to quickly create resumes with. These themes export a main `Resume` component as well as a smaller set of components to allow you to assemble your resume yourself.
React-Vitae previously included two ready made themes to quickly create resumes with. These themes are deprecated and are only kept for reference.

See each theme's readme for instruction on usage and how to install them.

* [react-vitae-bulma-theme](/packages/react-vitae-bulma-theme)
* [react-vitae-material-theme](/packages/react-vitae-material-theme)
* [react-vitae-bulma-theme](/themes/react-vitae-bulma-theme)
* [react-vitae-material-theme](/themes/react-vitae-material-theme)

### Help needed

The created templates are still work in progress at this moment. I am not a designer and they look somewhat passable, but help to make them look good would be very appreciated. Feel free to create a PR to improve the look of both templates.
Any Pull Request will be reviewed and merged if it looks good, all help is appreciated!

## Development

### Lerna

This project uses [lerna](https://github.com/lerna/lerna) to manage its monorepo, see the lerna documentation for more commands.

### Installing the dependencies

Running `npm bootstrap` in the project's root directory will install everything you need for development.
Running `npm install` in the project's root directory will install everything you need for development.

### Running Lint

Expand All @@ -156,4 +152,4 @@ Running `npm bootstrap` in the project's root directory will install everything

### Publishing

Publishing is done automatically through travis.
Publishing is done manually at the moment using the `npm publish` command.
1 change: 1 addition & 0 deletions example/src/bulma/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import { render } from 'react-dom';

// @ts-expect-error
import { Resume } from 'react-vitae-bulma-theme';
import { resume } from '../resume';

Expand Down
1 change: 1 addition & 0 deletions example/src/material/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import { render } from 'react-dom';

// @ts-expect-error
import { Resume } from 'react-vitae-material-theme';
import { resume } from '../resume';

Expand Down
File renamed without changes.
21 changes: 0 additions & 21 deletions lerna.json

This file was deleted.

Loading

0 comments on commit 62b9f6e

Please sign in to comment.