-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fix readme and SVG logo * Remove mock backup files
- Loading branch information
1 parent
7d76b34
commit 64dd160
Showing
10 changed files
with
8 additions
and
765 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,13 +6,13 @@ | |
<p align="center"> | ||
<img src="https://github.com/alexieyizhe/intern.plus/workflows/ci/badge.svg"> | ||
<img src="https://img.shields.io/github/v/tag/alexieyizhe/intern.plus?label=version"> | ||
<p align="center"> | ||
✨ intern+ aggregates information about the quality of a company's internship program, sourced directly through reviews from your peers – all designed to help you make an informed decision when it comes to choosing your next internship.</p> | ||
</p> | ||
|
||
##### ✨ intern+ aggregates information about the quality of a company's internship program, sourced directly through reviews from your peers – all designed to help you make an informed decision when it comes to choosing your next internship. Interested in how it was built? Check out a [timelapse of the design process](https://youtu.be/0Ioruq2xIXw) on YouTube. You can also watch a . | ||
|
||
## 🎨 Design | ||
|
||
See [the finished mocks](https://www.figma.com/file/FyfrbCpoSGAeY3eTROqPx5/intern?node-id=0%3A1) on Figma! | ||
Interested in how it was built? Check out a [timelapse of the design process](https://youtu.be/0Ioruq2xIXw) on YouTube or see [the preliminary mocks](https://www.figma.com/file/FyfrbCpoSGAeY3eTROqPx5/intern?node-id=0%3A1) on Figma! | ||
|
||
## 🥞 Tech Stack | ||
|
||
|
@@ -40,7 +40,6 @@ npm start | |
|
||
The project is split into the following parts: | ||
|
||
- `/cypress` holds logic for the Cypress end-to-end testing suite tool, as well as E2E tests. | ||
- `/api` contains the code for the GraphQL server & API. | ||
- `/src` contains the code for the React frontend: | ||
- `/api` contains client code for interacting with the graphql api. | ||
|
@@ -50,16 +49,15 @@ The project is split into the following parts: | |
- `/pages` is relatively self-explanatory: it holds the pages of the app. | ||
- `/shared` contains all shared code like constants, etc that are used in _multiple_ parts of the project. | ||
- `/theme` contains all code dealing with styles and theming of the app. | ||
- `/cypress` holds logic for the Cypress end-to-end testing suite tool, as well as E2E tests. | ||
|
||
For more information, consult the README in the root of each directory. | ||
|
||
#### GraphQL | ||
|
||
When in a development or test environment, the GraphQL API uses data generated by `faker` for local development. | ||
|
||
All code dealing with GraphQL resides in `/graphql` directories. These directories are co-located next to the parts of the applications using them. | ||
|
||
Each of these will contain logic like queries, fragments, etc. The types associated with the logic (auto-generated by Apollo tooling) reside in a `/graphql/types` subdirectory. The mocks for the logic (used in testing and local dev) reside in a `/graphql/mocks` subdirectory. | ||
Each of these will contain logic like queries, fragments, etc. The types associated with the logic (auto-generated by Apollo tooling) reside in a `/graphql/types` subdirectory. | ||
|
||
### Development conventions | ||
|
||
|
@@ -95,4 +93,4 @@ When code is ready to be reflected on production, cut a Github release with an a | |
|
||
Any new changes on the `release` branch is automatically built by Vercel and made live. | ||
|
||
###### Wanna get in touch? [Shoot Alex an email.](mailto:[email protected]) | ||
###### Wanna get in touch? [Shoot Alex an email](mailto:[email protected]). |
Oops, something went wrong.