go-germany

A site that collects all international programs in Germany and all related articles shared by applicants.
Explore the site »

View Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

As a prospective master student in Germany, I spent a lot of time searching for international programs and their related articles shared by applicants. I know there's a DAAD site which is helpful for searching the desired program; however, I don't like the way it displays search results and I think if I can find related articles shared by former applicants at the same time, that would be simply awesome, so I created this site. I want to create a search tool so amazing that it'll be the one you find your desired programs -- I think this it.

Here's why:

• Your time should be focused on your application.
• You shouldn't spend too much effort searching related articles from different sources.

(back to top)

Built With

The whole project consists of three repositories, go-germany, go-germany-api, and go-germany-sync, which are the frontend, the backend, and the data synchronization tool respectively.

go-germany

• TypeScript
• React.js
• React Redux
• Redux Toolkit
• Material UI

go-germany-api

• Go
• httprouter
• PostgreSQL
• pq

go-germany-sync

• Python
• asyncpg

(back to top)

Usage

• Search Programmes
  • Search by course's name, course's subject, university's English name or university's Chinese name
• Search Articles
  • Search by author, title, source, bachelor's (master's) university, bachelor's (master's) department, or the content of the article.
  • Full-text search supported
• Bookmark
  • Add your favorite programmes or articles to bookmark! You can later browse all of them at one go.
• Admin
  • For administrators only
  • Add new courses and articles after logging in

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/noworneverev/go-germany.git

2. Install NPM packages

   npm install

3. Enter your local api url in .env.development

   REACT_APP_API_URL=http://localhost:4000/v1/

4. Runs the app in the development mode

   npm start

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Yan-Ying Liao - Personal Portfolio - n9102125@gmail.com

Project Link:

• Frontend: https://noworneverev.github.io/go-germany/
• Backend: https://noworneverev.github.io/go-germany-api/
• Data synchronization tool: https://noworneverev.github.io/go-germany-sync/

(back to top)

Acknowledgments

• The programmes' data is parsed from and daily synchronized with DAAD Internation Programmes
• Img Shields
• GitHub Pages
• Heroku
• React Icons
• unDraw
• Chiao-Yun Chen - Mascot of the site
• All articles belong to their authors

(back to top)