Skip to content

Commit fe4332f

Browse files
committed
Update readme and cover transitions
1 parent 4926526 commit fe4332f

5 files changed

Lines changed: 77 additions & 13 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,43 @@ Please reach out if your interested in using the live app.
3232

3333
---
3434

35+
## Developing
36+
37+
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`).
38+
39+
### Frontend
40+
41+
Create a .env file and declare your server url. Ensure it's directed towards `/api`.
42+
43+
```bash
44+
REACT_APP_API_URL=http://localhost:5000/api
45+
```
46+
47+
Start a development server:
48+
49+
```bash
50+
npm start
51+
```
52+
53+
### Server
54+
55+
Create a .env file and declare your database URI and Secret Key
56+
57+
> You can generate a key using node builtins `require('crypto').randomBytes(64).toString('hex')`
58+
59+
```bash
60+
ATLAS_URI=<mongodb-connection-string>
61+
ACCESS_TOKEN_SECRET=<secret-key>
62+
```
63+
64+
Start a development server:
65+
66+
```bash
67+
npm start
68+
```
69+
70+
---
71+
3572
## Overview
3673

3774
### Involvement

root/bujots-front/package-lock.json

Lines changed: 29 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

root/bujots-front/src/components/JournalBack.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const JournalBack = ({ children }: Props) => {
1616
<motion.div className="col-start-2 col-end-3 row-start-2 row-end-3"
1717
initial={{ opacity: 0 }}
1818
animate={{ opacity: 1, transition: { ease: [0.075, 0.82, 0.165, 1], duration: 1 } }}
19-
exit={{ opacity: 0, rotate: -20, translateX: 100, translateY: 100 }}
19+
exit={{ opacity: 0, rotate: -5, translateX: 40, translateY: 40 }}
2020
transition={{ ease: "easeInOut", duration: .5 }}
2121
>
2222
{/* A4 Aspect Ratio 1:1.4142 */}

root/bujots-front/src/components/JournalCover.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const JournalCover = ({ children }: Props) => {
1717
<motion.div className="col-start-2 col-end-3 row-start-2 row-end-3"
1818
initial={{ opacity: 0 }}
1919
animate={{ opacity: 1, transition: { ease: [0.075, 0.82, 0.165, 1], duration: 1 } }}
20-
exit={{ opacity: 0, rotate: 20, translateX: -100, translateY: 100 }}
20+
exit={{ opacity: 0, rotate: 5, translateX: -40, translateY: 40 }}
2121
transition={{ ease: "easeInOut", duration: .5 }}
2222
>
2323
{/* A4 Aspect Ratio 1:1.4142 */}

root/server/package-lock.json

Lines changed: 9 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)