Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ndlano/listing-frontend
NDLA Listing frontend at https://liste.ndla.no
https://github.com/ndlano/listing-frontend
Last synced: about 2 months ago
JSON representation
NDLA Listing frontend at https://liste.ndla.no
- Host: GitHub
- URL: https://github.com/ndlano/listing-frontend
- Owner: NDLANO
- License: gpl-3.0
- Created: 2017-03-06T14:25:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-15T12:55:48.000Z (7 months ago)
- Last Synced: 2024-05-16T02:31:13.892Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 5.28 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NDLA Listing frontend
## Requirements
- Node.JS > 20.13.1
- yarn ~1.15.0
- Docker (optional)
## Getting started
What's in the box?
- React
- Redux
- Express
- Webpack + Babel (ES6)
### Dependencies
All dependencies are defined in `package.json` and are managed with npm. To
initially install all dependencies and when the list dependency has changed,
run `npm install`.
```
$ yarn install
```
### Start development server
Start node server with hot reloading middleware listening on port 3000.
```
$ yarn start
```
To use a different api set the `NDLA_API_URL` environment variable.
### Unit tests
Test framework: Jest with enzyme.
```
$ yarn test
```
### Code style
_tl;dr_: Use eslint! Rules: [Airbnb Styleguide]https://github.com/airbnb/javascript.
Lint code with [eslint](http://eslint.org/), including [eslint react plugin](https://github.com/yannickcr/eslint-plugin-react), [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import), [eslint-plugin-jsx-a11y](https://github.com/evcohen/eslint-plugin-jsx-a11y#readme).
Beside linting with globally installed eslint, eslint can be invoked with `npm`:
```
$ yarn run lint
```
Rules are configured in `./.eslintrc.js` and extends [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb). If feeling brave, try `eslint --fix`.
### Gql schema
The [eslint-plugin-graphql](https://github.com/apollographql/eslint-plugin-graphql) is used to check the queries against the GraphQL schema.
Make sure you have an running instance of the GraphQL enpoint with your latest changes
```yarn
yarn get-gql-schema-local
```
### TypeScript
[GraphQL code generator](https://www.graphql-code-generator.com/) is used to generate TypeScript types from the local GraphQL schema and queries.
```yarn
yarn generate-gql-types
```
The configuration is found in `codegen.yml`.
## Other scripts
```
# Create minified production ready build with webpack:
$ yarn run build
```
```
# Docker stuff
$ ./build.sh
```