Skip to content

Commit

Permalink
Remove backend code (#1105)
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronMoat authored Apr 23, 2024
1 parent 0441256 commit be73759
Show file tree
Hide file tree
Showing 49 changed files with 123 additions and 5,474 deletions.
1 change: 0 additions & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
* @seek-oss/indirect

# Configured by Renovate
be/package.json
fe/package.json
package.json
yarn.lock
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ tsconfig.json
.ssl/
node_modules/

/be/lib/

/tsconfig.json

.DS_Store
12 changes: 4 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ so don't commit or post anything that isn't ready for the entire world to see.

Wingman is documented through its [README](/README.md).
We maintain changelogs and [release notes] on GitHub,
and distribute underlying components as npm packages ([wingman-be], [wingman-fe]).
and distribute underlying components as npm packages ([wingman-fe]).

Frontend components can be previewed through a [Storybook].
We plan to host the Wingman example stack publicly at some point ([#3](https://github.com/seek-oss/wingman/issues/3)).
Expand All @@ -53,7 +53,7 @@ This lets us evaluate whether the feature fits the direction of the project and

### Prerequisites

We depend on upstream tooling like **[sku]** and **[skuba]** that are predominantly tested on macOS and Linux.
We depend on upstream tooling like **[sku]** that are predominantly tested on macOS and Linux.
If you're on Windows, we recommend the [Windows Subsystem for Linux].

First, some JavaScript tooling:
Expand Down Expand Up @@ -108,7 +108,6 @@ If all is well, they will merge your pull request into master.
You may find it easier to develop alongside unit tests:

```shell
yarn be test --watch
yarn fe test --watch
```

Expand All @@ -131,7 +130,6 @@ yarn test
Start local development servers:

```shell
yarn be start
yarn fe start
```

Expand All @@ -145,14 +143,14 @@ You'll see a 🦋 bot gliding around pull requests.
You should write a changeset if you are changing the public Wingman interface,
which includes:

- Package code under [be/src](/be/src) and [fe/lib](/fe/lib)
- Package code under [fe/lib](/fe/lib)
- npm dependencies

On the other hand,
a changeset is not necessary for:

- Documentation like the [README](/README.md)
- Example code under [be/example](/be/example) and [fe/example](/fe/example)
- Example code under [fe/example](/fe/example)
- Internal refactoring that preserves the existing interface
- npm dev dependencies

Expand Down Expand Up @@ -224,9 +222,7 @@ git push --set-upstream origin beta
[seek api]: https://developer.seek.com/introduction
[semantic versioning]: https://semver.org/
[sku]: https://github.com/seek-oss/sku
[skuba]: https://github.com/seek-oss/skuba
[storybook]: https://seek-oss.github.io/wingman/
[submit an issue]: https://github.com/seek-oss/wingman/issues/new/choose
[windows subsystem for linux]: https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux
[wingman-be]: https://www.npmjs.com/package/wingman-be
[wingman-fe]: https://www.npmjs.com/package/wingman-fe
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
[![GitHub Release](https://github.com/seek-oss/wingman/workflows/Release/badge.svg?branch=master)](https://github.com/seek-oss/wingman/actions?query=workflow%3ARelease)
[![GitHub Validate](https://github.com/seek-oss/wingman/workflows/Validate/badge.svg?branch=master)](https://github.com/seek-oss/wingman/actions?query=workflow%3AValidate)
[![Node.js version](https://img.shields.io/badge/node-%3E%3D%2012-brightgreen)](https://nodejs.org/en/)
[![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)

Reference implementation of a SEEK-integrated recruitment system.

Expand Down Expand Up @@ -71,7 +70,6 @@ Wingman is a mock recruitment system that integrates with the [SEEK API] to post
It comprises:

- [A frontend React application](/fe)
- [A backend Node.js GraphQL server](/be)

Wingman serves as a practical reference for third-party developers integrating with the SEEK API,
and complements the detailed documentation on our [developer site].
Expand All @@ -82,10 +80,6 @@ Internally, we maintain a private implementation to [dogfood] additions and chan
### Structure

```shell
├── be
│ ├── example
│ ├── src
│ └── ...
├── fe
│ ├── example
│ ├── lib
Expand All @@ -94,10 +88,7 @@ Internally, we maintain a private implementation to [dogfood] additions and chan
└── README.md <- you are here
```

Wingman is developed in a monorepo.
This makes it easier for us to release changes across the frontend and backend.

The frontend and backend contain components (under [/fe/lib](/fe/lib) and [/be/src](/be/src) respectively) that are packaged and published to npm.
The frontend contains components (under [/fe/lib](/fe/lib)) that are packaged and published to npm.
This allows us to share code between the public implementation of Wingman in this repo and SEEK’s own private implementation.

## Usage
Expand All @@ -123,7 +114,6 @@ yarn install
Start local development servers:

```shell
yarn be start
yarn fe start
```

Expand All @@ -137,7 +127,6 @@ Wingman is built on a bunch of other stuff that we’ve open sourced:
- [Koala], a collection of Koa add-ons
- [Scoobie], a Braid component library
- [sku](https://github.com/seek-oss/sku), a frontend development toolkit
- [skuba], a backend development toolkit

[braid]: https://github.com/seek-oss/braid-design-system
[developer site]: https://developer.seek.com
Expand All @@ -147,6 +136,5 @@ Wingman is built on a bunch of other stuff that we’ve open sourced:
[scoobie]: https://github.com/seek-oss/scoobie
[seek api]: https://developer.seek.com/introduction
[sku]: https://github.com/seek-oss/sku
[skuba]: https://github.com/seek-oss/skuba
[windows subsystem for linux]: https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux
[yarn workspaces]: https://classic.yarnpkg.com/en/docs/workspaces/
23 changes: 0 additions & 23 deletions be/.dockerignore

This file was deleted.

15 changes: 0 additions & 15 deletions be/.eslintignore

This file was deleted.

3 changes: 0 additions & 3 deletions be/.eslintrc.js

This file was deleted.

29 changes: 0 additions & 29 deletions be/.gitignore

This file was deleted.

8 changes: 0 additions & 8 deletions be/.prettierignore

This file was deleted.

1 change: 0 additions & 1 deletion be/.prettierrc.js

This file was deleted.

Loading

0 comments on commit be73759

Please sign in to comment.