search

joschan21 / profanity.dev

1.38k stars 106 forks source link

Add a README.md file at root #21

Open MathPow opened 6 months ago

MathPow commented 6 months ago

I am a new contributors and it would be nice to others new newcomers if they could can quickly understand the project and get started without needing to ask questions or search through code.

I think it is a key tool for a project like this. Maybe someone is already working on this, but I didn't found it in my quick tour.

Thanks!

NatanaelBorges commented 6 months ago

I'm also in agreement that this approach is well-aligned. There's already an open PR for the README template, providing an opportunity to include vital information for new contributors like project setup instructions, etc. Please feel free to contribute as well, your input would be greatly valued.

MathPow commented 6 months ago

I am not able to start contributing. I can't seem to be able to run the project. I am new to this structure and I need some guidance.

SamZie001 commented 6 months ago

I am not able to start contributing. I can't seem to be able to run the project. I am new to this structure and I need some guidance.

Hello, what part are you finding difficult to setup and run the application?

ZachLTech commented 5 months ago

there's no .env sample file (I'm not sure what .env variables are necessary)