Skip to content

Commit 6067193

Browse files
xiaohkxiaohk
committed
Add readme
Signed-off-by: Jay Wang <[email protected]>
1 parent 6975953 commit 6067193

File tree

5 files changed

+138
-4
lines changed

5 files changed

+138
-4
lines changed

‎.github/workflows/build.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: build
2+
3+
on:
4+
# Triggers the workflow on push or pull request events but only for the main branch
5+
push:
6+
branches: [main]
7+
pull_request:
8+
branches: [main]
9+
#: Run the test every week
10+
schedule:
11+
- cron: '0 12 * * 1'
12+
13+
jobs:
14+
build:
15+
runs-on: ${{ matrix.os }}
16+
17+
strategy:
18+
matrix:
19+
node-version: [16]
20+
os: [ubuntu-latest]
21+
22+
steps:
23+
- uses: actions/checkout@v3
24+
- uses: actions/setup-node@v3
25+
with:
26+
node-version: ${{ matrix.node-version }}
27+
- name: Install dependencies
28+
run: npm install
29+
- name: Build
30+
run: npm run build

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024, Jay Wang
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<h1>RecRec <a href="https://poloclub.github.io/recrec/"><picture>
2+
3+
<source media="(prefers-color-scheme: dark)" srcset="public/android-chrome-192x192.png">
4+
<img align="right" alt="RecRec logo." src="public/android-chrome-192x192.png" width="30" height="30">
5+
</picture></a></h1>
6+
7+
[![Github Actions Status](https://github.com/xiaohk/recrec/workflows/build/badge.svg)](https://github.com/xiaohk/recrec/actions/workflows/build.yml)
8+
[![license](https://img.shields.io/badge/License-MIT-blue)](https://github.com/xiaohk/recrec/blob/main/LICENSE)
9+
[![npm](https://img.shields.io/npm/v/recrec?color=yellow)](https://www.npmjs.com/package/recrec)
10+
11+
Recommender for recommendation letter writers 👍
12+
13+
<a href="https://xiaohk.github.io/wordflow"><img width="100%" src='https://i.imgur.com/QaWYWni.png'></a>
14+
15+
## What is RecRec?
16+
17+
RecRec is a practical tool for finding academic recommendation letter writers.
18+
Whether you are applying for a fellowship, job, or green card petition, RecRec helps you quickly identify the best letter writers.
19+
RecRec highlights connections between you and potential recommenders and lets you filter by citations, awards, and other criteria.
20+
Save time and get the most impactful recommendations with RecRec!
21+
22+
## Get Started
23+
24+
To use RecRec, visit: <https://xiaohk.github.io/recrec/>.
25+
26+
## Developing RecRec
27+
28+
Clone or download this repository:
29+
30+
```bash
31+
git clone [email protected]:xiaohk/recrec.git
32+
```
33+
34+
Install the dependencies:
35+
36+
```bash
37+
npm install
38+
```
39+
40+
Then run RecRec:
41+
42+
```
43+
npm run dev
44+
```
45+
46+
Navigate to localhost:3000. You should see RecRec running in your browser :)
47+
48+
## Credits
49+
50+
RecRec is created by <a href='https://zijie.wang/' target='_blank'>Jay Wang</a>.
51+
52+
<!----
53+
54+
## Citation
55+
56+
To learn more about RecRec and social prompt engineering, check out our [research paper](https://arxiv.org/abs/2401.14447).
57+
58+
```bibtex
59+
@article{wangWordflowSocialPrompt2024,
60+
title = {Wordflow: {{Social Prompt Engineering}} for {{Large Language Models}}},
61+
shorttitle = {Wordflow},
62+
author = {Wang, Zijie J. and Chakravarthy, Aishwarya and Munechika, David and Chau, Duen Horng},
63+
year = {2024},
64+
url = {http://arxiv.org/abs/2401.14447},
65+
urldate = {2024-01-29},
66+
archiveprefix = {arxiv},
67+
journal = {arXiv 2401.14447}
68+
}
69+
```
70+
71+
--->
72+
73+
## License
74+
75+
The software is available under the [MIT License](https://github.com/xiaohk/recrec/blob/main/LICENSE).
76+
77+
## Contribution
78+
79+
Feature requests, bug reports, and fixes are all welcome! Start by [opening an issue](https://github.com/xiaohk/recrec/issues/new).
80+
81+
## Contact
82+
83+
If you have any questions, feel free to [open an issue](https://github.com/xiaohk/recrec/issues/new) or contact [Jay Wang](https://zijie.wang).

‎package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "jay",
3-
"private": true,
4-
"version": "0.0.0",
2+
"name": "recrec",
3+
"private": false,
4+
"version": "0.0.1",
55
"type": "module",
66
"scripts": {
77
"dev": "vite --port 3000",

‎vite.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export default defineConfig(({ command, mode }) => {
3434
case 'github': {
3535
// Production: github page (default mode)
3636
return {
37-
base: '/wordflow/',
37+
base: '/recrec/',
3838
build: {
3939
outDir: 'dist',
4040
rollupOptions: {

0 commit comments

Comments
 (0)