https://github.com/carvilsi/pwyll

Snippet manager
https://github.com/carvilsi/pwyll

manager mongodb service snippet

Last synced: 27 days ago
JSON representation

Snippet manager

• Host: GitHub
• URL: https://github.com/carvilsi/pwyll
• Owner: carvilsi
• License: other
• Created: 2024-01-25T16:09:03.000Z (11 months ago)
• Default Branch: develop
• Last Pushed: 2024-09-04T15:49:47.000Z (4 months ago)
• Last Synced: 2024-09-06T19:54:16.188Z (4 months ago)
• Topics: manager, mongodb, service, snippet
• Language: TypeScript
• Homepage:
• Size: 384 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

  


  


    

  

  
a simple snippet manager service



# pwyll 

This is the server side of Pwyll.

If you want to interact with pwyll, there is a **cli** for **nodejs** [pwyll-cli](https://github.com/carvilsi/pwyll-cli)

## Run

Pwyll server needs a MongoDB connection in order to store the snippets.

### Docker

No doubt about that this one is the most useful way to run it. There is a Docker volume, so the data will be persisted.

At the **devops** directory, run the following command, which will start the pwyll server and MongoDB:

`$ docker-compose up -d`

Notice that if you are going to run this in a server with internet connectivity, you should change the configuration parameters for the MongoDB like username a password. Also most probably, you should run this with some kind of secure connection with **letsencrypt**.

## Testing

Apart from the CI/CD configured for GitHub workflows, you can run the test locally, to do that:

- First run the pwyll server with `$ npm run build && npm start`

- Then run the tests with `$ npm run dev-test` this will start a dockerized MongoDB and will run the tests.

If you do not want to have Docker, then just run an instance of MongoDB locally and witht the pwyll server runinng, execute the tests with `$ ./node_modules/jest/bin/jest.js --runInBand test/`. Notice that the tests need to run on a clean database.

---

Feedback from usage and contributions are very welcome.

Also if you like it, please leave a :star: I would appreciate it ;)