https://github.com/zurfyx/memories
:sunny: Your travelling stories in a social web app | Google Summer of Code 2017 @ Physical Web
https://github.com/zurfyx/memories
angular firebase liquid-galaxy memories physical-web typescript
Last synced: 27 days ago
JSON representation
:sunny: Your travelling stories in a social web app | Google Summer of Code 2017 @ Physical Web
- Host: GitHub
- URL: https://github.com/zurfyx/memories
- Owner: zurfyx
- License: mit
- Created: 2017-05-29T12:12:37.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-25T19:30:16.000Z (over 7 years ago)
- Last Synced: 2025-03-29T15:11:54.081Z (about 2 months ago)
- Topics: angular, firebase, liquid-galaxy, memories, physical-web, typescript
- Language: TypeScript
- Homepage: https://geographical-memories.firebaseapp.com/
- Size: 969 KB
- Stars: 1
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Memories
> A social platform to share your worldwide memories.
[](https://travis-ci.org/zurfyx/memories)
[](https://david-dm.org/zurfyx/memories)
[](https://codeclimate.com/github/zurfyx/memories)
## Live
Live @ [geographical-memories.firebaseapp.com](https://geographical-memories.firebaseapp.com)
## Getting started
Want to run this project yourself?
Requirements:
- [Node 8+](https://nodejs.org/)
- Firebase project (create one [here](https://console.firebase.google.com))
Edit `src/environments/environment.prod.ts` to suit your needs. The current configuration is the one used at [https://geographical-memories.firebaseapp.com](https://geographical-memories.firebaseapp.com)
```
export const environment = {
production: true,
firebase: {
// Inside a Firebase project, they will provide you with all this information at once.
// Overview -> Add Firebase to your web app.
apiKey: 'AIzaSyC84AqlQQSAJQxvdkJ_U6EGw6TTQpV-PBA',
authDomain: 'geographical-memories.firebaseapp.com',
databaseURL: 'https://geographical-memories.firebaseio.com',
projectId: 'geographical-memories',
storageBucket: 'geographical-memories.appspot.com',
messagingSenderId: '1078012876993',
},
maps: {
// https://developers.google.com/maps/documentation/javascript/get-api-key
apiKey: 'AIzaSyDB8v_lXYf4FGzrv5gmJvUaZaDRfck2QbE',
},
urlShortener: {
// https://developers.google.com/url-shortener/v1/getting_started
apiKey: 'AIzaSyBNGykVSDx3ZNdGnlZU1wne2eT3uAkywiU',
}
};
```
Install project dependencies first with `npm install`.
Build the project with `npm run build`.
Serve the built project yourself or upload the `dist/` project onto the Firebase hosting.
Either if you are serving the project yourself or uploading it onto the Firebase hosting, you do need to modify the `.firebaserc` file to match the name of your own Firebase project. That is because the database and storage rules do still have to be uploaded to Firebase (unless you are doing this process manually by copy-pasting the contents in `firebase/database.rules.json`).
To have everything uploaded inside Firebase, install Firebase Tools first.
```
npm install -g firebase-tools
```
Afterwards, run:
```
firebase deploy
```
Your own Geographical Memories version should now be live!
## Built with
Core technologies/dependencies:
- [TypeScript](https://www.typescriptlang.org)
- [Angular 4](https://angular.io)
- [Angular Material](https://material.angular.io)
- [Firebase](https://firebase.google.com) - Real time database and Storage
- [Angularfire2](https://github.com/angular/angularfire2)
## Development
Want to help with the development of Geographical Memories?
Requirements:
- [Node 8+](https://nodejs.org/)
- Firebase project to test your modifications on a non-production environment (create one [here](https://console.firebase.google.com))
Edit `src/environments/environment.ts` to suit your needs.
Install dependencies with `npm install` and run the project as development with `npm start`. Make sure to run a full set of tests with `npm test` before commiting!
We are following [https://github.com/gothinkster/angular-realworld-example-app](https://github.com/gothinkster/angular-realworld-example-app) when it comes to the application coding structure and style.
It is to note that we are also using a [CoreModule](https://angular.io/guide/ngmodule#configure-core-services-with-coremoduleforroot) to store our servies, to prevent what should be singletons from reinitializating themselves when splitting the `bundle.js` [into chunks](https://github.com/zurfyx/memories/blob/master/src/app/app-routing.module.ts).
## Contributions
Contributions are welcome. See [Development](#development).
## License
MIT © [Gerard Rovira Sánchez](//zurfyx.com)
