Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oddbit/tanam
Plug-n-play CMS for websites on Firebase
https://github.com/oddbit/tanam
angular cms dustjs firebase firebase-authentication firebase-cloud-functions firebase-firestore firebase-hosting firebase-storage npm-module typescript
Last synced: about 11 hours ago
JSON representation
Plug-n-play CMS for websites on Firebase
- Host: GitHub
- URL: https://github.com/oddbit/tanam
- Owner: oddbit
- License: apache-2.0
- Created: 2018-04-24T03:49:34.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T02:07:21.000Z (7 months ago)
- Last Synced: 2024-05-23T02:40:56.820Z (7 months ago)
- Topics: angular, cms, dustjs, firebase, firebase-authentication, firebase-cloud-functions, firebase-firestore, firebase-hosting, firebase-storage, npm-module, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/tanam
- Size: 19.8 MB
- Stars: 180
- Watchers: 22
- Forks: 39
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tanam 🌱 Plug-n-play CMS for websites on Firebase
Our aim is to provide a self hosted publishing platform for Firebase.
TanamCMS is the easiest way to build a website for dynamic content such as a blogging platform where you easily can publish and manage your content, even schedule posts to be published.
Tanam also has a built in AI ghostwriter that can help you generate articles in your own writing style. You provide the draft or voice transcript and the ghostwriter will make it into a well written article for you.
# Set up
You will need to configure the Next app in the dot-env file `apps/cms/.env`. You can find an template file named `apps/cms/.env.local.example` to rename and populate with values.
## Build and run locally
Install all dependencies and serve locally.
```sh
npm install
npm run serve
```
## Deploy to Firebase
Follow the [documentation for Firebase App Hosting](https://firebase.google.com/docs/app-hosting)
on how to set up your application for automatic deployment.
### Configure Firebase cloud
In order to deploy to Firebase App Hosting you will need to set up some secrets on GCP Secrets Manager.
Follow the steps below to configure it from command line.
Read the environment variables from the CMS configuration
```sh
source apps/cms/.env
source .env
```
Copy and paste all these to set up. Be patient, it will take a little while to complete all variable configuration.
```sh
echo $NEXT_PUBLIC_FIREBASE_API_KEY | firebase apphosting:secrets:set --force --data-file - tanamApiKey
echo $NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN | firebase apphosting:secrets:set --force --data-file - tanamAuthDomain
echo $NEXT_PUBLIC_FIREBASE_DATABASE_URL | firebase apphosting:secrets:set --force --data-file - tanamDatabaseUrl
echo $NEXT_PUBLIC_FIREBASE_PROJECT_ID | firebase apphosting:secrets:set --force --data-file - tanamProjectId
echo $NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET | firebase apphosting:secrets:set --force --data-file - tanamStorageBucket
echo $NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID | firebase apphosting:secrets:set --force --data-file - tanamMessagingSenderId
echo $NEXT_PUBLIC_FIREBASE_APP_ID | firebase apphosting:secrets:set --force --data-file - tanamAppId
echo $NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID | firebase apphosting:secrets:set --force --data-file - tanamMeasurementId
echo $GEMINI_API_KEY | firebase apphosting:secrets:set --force --data-file - tanamGenAiApiKey
```
You will need to grant access to your app-hosting backend if this is the first time you are setting the variables
and if you didn't enable access to all variables in the `apphosting:secrets:set` step.
```sh
export APP_HOSTING_BACKEND=
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamApiKey
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamAuthDomain
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamDatabaseUrl
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamProjectId
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamStorageBucket
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamMessagingSenderId
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamAppId
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamMeasurementId
firebase apphosting:secrets:grantaccess --backend $APP_HOSTING_BACKEND tanamGenAiApiKey
```
# License
```
Copyright oddbit
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```