Skip to content

Commit 715fb98

Browse files
RajdeepcRajdeepc
committed
first commit
0 parents  commit 715fb98

File tree

126 files changed

+35120
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+35120
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.gitignore‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.DS_Store
2+
node_modules/
3+
/dist
4+
5+
# local env files
6+
.env
7+
.env.local
8+
.env.*.local
9+
10+
# Log files
11+
npm-debug.log*
12+
yarn-debug.log*
13+
yarn-error.log*
14+
15+
# Editor directories and files
16+
.idea
17+
.vscode
18+
*.suo
19+
*.ntvs*
20+
*.njsproj
21+
*.sln
22+
*.sw?

‎Procfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
worker: node server.js

‎README.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Teleport - A simplified alternative to POSTMAN
2+
3+
## A simplified alternative to POSTMAN with features like response differ and hyper runs
4+
5+
> In response to numerous feedbacks, I have already started working on Phase 2. I will bring the key checker switch and hyper run which will be "live" soon.
6+
>
7+
> Thanks for your continuous support. Stay tuned! :muscle:
8+
9+
10+
This is not only a simplified POSTMAN close built with **react**, but also an example of a more customizable, personalized alternative to POSTMAN.
11+
12+
## Working application
13+
14+
Check out the **live demo** -> https://lintrest.herokuapp.com
15+
16+
17+
If you like my work, feel free to:
18+
19+
- [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)][tweet] about alternative to POSTMAN
20+
- :star: this repository. And I will be happy together :)
21+
22+
Thanks a bunch for stopping by and supporting me!
23+
24+
[tweet]: https://twitter.com/intent/tweet?url=https://github.com/Rajdeepc/version-REST&text=Awesome%20POSTMAN%20clone%20app%20built%20with%20React%20and%20NodeJS&hashtags=react,nodejs,indexdb
25+
26+
## Who is it for 🤷‍♀️
27+
28+
I have been working with React for about four years. I built cool stuff at [Github](https://github.com/Rajdeepc) and so I wanted to try out to build a cool alternative to POSTMAN with bunch of new features for **developers** and **testers**.
29+
30+
This is a showcase application I've built in my spare time to experiment the power of React that I wanted to try before: `React`, `NodeJS`, `IndexDB`.
31+
32+
There are not many alternative to REST client applications like POSTMAN on the web and I think that this codebase contains enough complexity to offer valuable insights to **React developers of all skill levels** while still being _relatively_ easy to understand.
33+
34+
---
35+
36+
This piece of application is a long term release of new features which can be seen in the Release notes which I am planning to push every month. The product will be live soon for production use.
37+
38+
[Rajdeep]: http://reactive-rajdeep.netlify.com/
39+
40+
## Tech stack
41+
42+
43+
- React CRA
44+
- Redux state management
45+
- UI modules:
46+
- SASS
47+
- React Router
48+
- Heroku
49+
- NodeJS
50+
- HapiJS
51+
- shortid
52+
- xoauth
53+
- Mongoose
54+
- MongoDB Atlas
55+
- mlab
56+
- IndexDB - In mermory database
57+
- Google Single Sign On
58+
59+
60+
## Features and Roadmap
61+
62+
I set the tentative deadline for motivating myself to finish the work on time. Otherwise, It will take forever to complete :)
63+
64+
### Phase 1 - MERN application with IndexDB and SSO support
65+
66+
> June Release, 2020
67+
68+
- [x] Compare Response Feature - Compare responses of the same API once response structure changes
69+
- [x]Add or remove API Endpoints - Add and remove API endpoints from EndPoints tab
70+
- [x]Search Endpoints - Search through your API Endpoints with Smart Search
71+
- [x]Sign In Feature - Sign In to save all your api
72+
- [x]Notification Swtich - Switch On/Off Notifications
73+
- [x]Generate Code - Generate Code from your API constructs
74+
- [x]More Personalized Settings - More Personalised Settings Feature
75+
- [x]IndexDB Support - Localized data now saved in IndexDB for more storage
76+
77+
### Phase 2
78+
79+
> Sept Release, 2020
80+
81+
- [ ] Refactor the mono repo to use Nx Workspace
82+
- [ ] GraphQL API and store data on the actual database
83+
- [ ] Authentication
84+
- [ ] Websocket realtime update
85+
- [ ] Interactive report
86+
87+
## Time spending
88+
89+
It is a side project that I only spent time outside of the office hours to work on.
90+
91+
I have spent about 80 hours working on this project which is equivalent to watching the whole Stranger Things series twice.
92+
93+
94+
## What's currently missing?
95+
96+
There are missing features from the live demo which should exist in a real product. All of them will be finished on Phase 2:
97+
98+
### Import JSON collection
99+
100+
I would like to build this feature for a robust JSON parser which can import and parse any type of JSON
101+
102+
### Diff checker for testers and developers
103+
104+
This feature will hold a switch which will enable diff checker for attribute for testers and the value for developers. This could make a good feature for testers to check for any changes in attribute of the current response
105+
106+
107+
### Accessibility ♿
108+
109+
Not all components have properly defined [aria attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA), visual focus indicators, etc.
110+
111+
## Setting up development environment 🛠
112+
113+
- `git clone https://github.com/Rajdeepc/teleport.git`
114+
- `cd teleport`
115+
- `npm run start` for the API
116+
- The API server should run on `http://localhost:3000`
117+
- `npm run start` for angular web application
118+
- The app should run on `http://localhost:4200/`
119+
120+
### Unit/Integration tests 🧪
121+
122+
Unit Testing done with React Testing Library.
123+
124+
## Compatibility
125+
126+
It was being tested on IE 11, Chrome and Firefox. For Safari, there are some minor alignment issues.
127+
128+
## Author: Rajdeep Chandra ✍️
129+
130+
- A seasoned Full Stack Engineer. Working with React and Vue NodeJS and Web Security. Like photography, gadgets, cooking, and reading books.
131+
- Personal blog: http://reactive-rajdeep.netlify.com/
132+
- Say hello: rajrock38 [et] gmail [dot] com
133+
134+
## Contributing
135+
136+
If you have any ideas, just open an issue and tell me what you think.
137+
138+
If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
139+
140+
## Credits
141+
142+
Inspired by [POSTMAN](https://github.com/postmanlabs)
143+
144+
I reused part of the HTML and CSS code from these projects.
145+
146+
## License
147+
148+
Feel free to use my code on your project. It would be great if you put a reference to this repository.
149+
150+
[MIT](https://opensource.org/licenses/MIT)

‎README1.md‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# Teleport - A simplified POSTMAN clone
2+
3+
## A simplified POSTMAN clone with response differ and hyper runs
4+
5+
> In response to numerous feedbacks, I have already started working on Phase 2. I will bring the key checker switch and hyper run "live" soon.
6+
>
7+
> Thanks for your continuous support. Stay tuned! :muscle:
8+
9+
10+
This is not only a simplified POSTMAN close built with **react**, but also an example of a more customizable, personalized alternative to POSTMAN.
11+
12+
## Working application
13+
14+
Check out the **live demo** -> https://lintrest.herokuapp.com
15+
16+
17+
If you like my work, feel free to:
18+
19+
- [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)][tweet] about POSTMAN clone
20+
- :star: this repository. And I will be happy together :)
21+
22+
Thanks a bunch for stopping by and supporting me!
23+
24+
[tweet]: https://twitter.com/intent/tweet?url=https://github.com/Rajdeepc/version-REST&text=Awesome%20POSTMAN%20clone%20app%20built%20with%20React%20and%20NodeJS&hashtags=react,nodejs,indexdb
25+
26+
## Who is it for 🤷‍♀️
27+
28+
I have been working with React for about four years. I built cool stuff at [Github](https://github.com/Rajdeepc) and so I wanted to try out to build another cool alternative to POSTMAN with bunch of new features for developers and testers.
29+
30+
This is a showcase application I've built in my spare time to experiment the power of React that I wanted to try before: `React`, `NodeJS`, `IndexDB`.
31+
32+
There are not many alternative to REST client applications like POSTMAN on the web and I think that this codebase contains enough complexity to offer valuable insights to **React developers of all skill levels** while still being _relatively_ easy to understand.
33+
34+
---
35+
36+
This piece of application is a long term release of new features which can be seen in the Release notes which I am planning to push every month. The product will be live soon for production use.
37+
38+
[Rajdeep]: http://reactive-rajdeep.netlify.com/
39+
40+
## Tech stack
41+
42+
43+
- React CRA
44+
- Redux state management
45+
- UI modules:
46+
- SASS
47+
- React Router
48+
- Heroku
49+
- NodeJS
50+
- HapiJS
51+
- shortid
52+
- xoauth
53+
- Mongoose
54+
- MongoDB Atlas
55+
- mlab
56+
- IndexDB - In mermory database
57+
- Google Single Sign On
58+
59+
60+
## Features and Roadmap
61+
62+
I set the tentative deadline for motivating myself to finish the work on time. Otherwise, It will take forever to complete :)
63+
64+
### Phase 1 - Angular application and simple Nest API
65+
66+
> June 13 - 27, 2020
67+
68+
- [x] Compare Response Feature - Compare responses of the same API once response structure changes
69+
- [x]Add or remove API Endpoints - Add and remove API endpoints from EndPoints tab
70+
- [x]Search Endpoints - Search through your API Endpoints with Smart Search
71+
- [x]Sign In Feature - Sign In to save all your api
72+
- [x]Notification Swtich - Switch On/Off Notifications
73+
- [x]Generate Code - Generate Code from your API constructs
74+
- [x]More Personalized Settings - More Personalised Settings Feature
75+
- [x]IndexDB Support - Localized data now saved in IndexDB for more storage
76+
77+
### Phase 2
78+
79+
> July 10 - 25, 2020
80+
81+
- [ ] Refactor the mono repo to use Nx Workspace
82+
- [ ] GraphQL API and store data on the actual database
83+
- [ ] Authentication
84+
- [ ] Websocket realtime update
85+
- [ ] Interactive report
86+
87+
## Time spending
88+
89+
It is a side project that I only spent time outside of the office hours to work on.
90+
91+
I have spent about 80 hours working on this project. Which is equivalent to watch the whole Stranger Things series twice.
92+
93+
94+
## What's currently missing?
95+
96+
There are missing features from the live demo which should exist in a real product. All of them will be finished on Phase 2:
97+
98+
### Import JSON collection
99+
I would like to build this feature for a robust JSON parser which can import and parse any type of JSON
100+
101+
### Diff checker for testers and developers
102+
This feature will hold a switch which will enable diff checker for attribute for testers and the value for developers. This could make a good feature for testers to check for any changes in attribute of the current response
103+
104+
105+
### Accessibility ♿
106+
107+
Not all components have properly defined [aria attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA), visual focus indicators, etc.
108+
109+
## Setting up development environment 🛠
110+
111+
- `git clone https://github.com/Rajdeepc/teleport.git`
112+
- `cd teleport`
113+
- `npm run start` for the API
114+
- The API server should run on `http://localhost:3000`
115+
- `npm run start` for angular web application
116+
- The app should run on `http://localhost:4200/`
117+
118+
### Unit/Integration tests 🧪
119+
120+
Unit Testing done with React Testing Library.
121+
122+
## Compatibility
123+
124+
It was being tested on IE 11, Chrome and Firefox. For Safari, there are some minor alignment issues.
125+
126+
## Author: Rajdeep Chandra ✍️
127+
128+
- A seasoned Full Stack Engineer. Working with React and Vue NodeJS and Web Security. Like photography, gadgets, cooking, and reading books.
129+
- Personal blog: http://reactive-rajdeep.netlify.com/
130+
- Say hello: rajrock38 [et] gmail [dot] com
131+
132+
## Contributing
133+
134+
If you have any ideas, just open an issue and tell me what you think.
135+
136+
If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
137+
138+
## Credits
139+
140+
Inspired by [POSTMAN](https://github.com/postmanlabs)
141+
142+
I reused part of the HTML and CSS code from these projects.
143+
144+
## License
145+
146+
Feel free to use my code on your project. It would be great if you put a reference to this repository.
147+
148+
[MIT](https://opensource.org/licenses/MIT)

‎client/.gitignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/.docz
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*

0 commit comments

Comments
 (0)